14- كورس HTML للمبتدئين – إضافة التعليقات داخل الكود

تُعدّ التعليقات في HTML من الأمور المهمة جدًا أثناء كتابة صفحات الويب، لأنها تساعد المبرمج على تنظيم الكود وشرح أجزائه دون أن تظهر هذه الملاحظات للزائر داخل المتصفح.

تُستخدم التعليقات عادةً لتوضيح وظيفة جزء معين من الكود، أو لتذكير المطور بشيء ما، أو لتعطيل جزء من الكود مؤقتًا أثناء التجربة والاختبار.

ما هي التعليقات في HTML؟

التعليق في HTML هو نص يكتبه المطور داخل الصفحة، لكنه لا يظهر للمستخدم عند فتح الموقع في المتصفح.
ويتم كتابة التعليق باستخدام الصيغة التالية:

مثال:
<!-- هذا تعليق في HTML -->

أي نص يتم وضعه بين يعتبر تعليقًا، ولن يتم عرضه داخل الصفحة.

لماذا نستخدم التعليقات في HTML؟

هناك عدة فوائد لاستخدام التعليقات داخل كود HTML، من أهمها:

توضيح وظيفة أجزاء الكود.

تسهيل فهم الصفحة عند العودة إليها لاحقًا.

مساعدة فريق العمل على قراءة الكود بسرعة.

تعطيل جزء من الكود مؤقتًا بدون حذفه.

تنظيم الملفات الكبيرة وتقسيم الأقسام داخل الصفحة.

مثال بسيط على تعليق داخل HTML

في المثال التالي نضيف عنوانًا وفقرة، ونضع تعليقًا لتوضيح محتوى الكود:

مثال:
<!DOCTYPE html> <html> <head> <title>صفحة تجريبية</title> </head> <body> <!-- هذا عنوان رئيسي للصفحة --> <h1>مرحبًا بك في موقعي</h1>
<!-- هذه فقرة ترحيبية -->
<p>هذه أول صفحة HTML أقوم بإنشائها.</p>
</body> </html>

في هذا المثال، التعليقات موجودة فقط لتوضيح وظيفة العناصر، لكنها لن تظهر داخل الصفحة عند عرضها في المتصفح.

شكل كتابة التعليق الصحيح في HTML

يجب أن يبدأ التعليق بهذا الشكل:

مثال:
<!--
وينتهي بهذا الشكل:
مثال:
-->

أما الشكل الكامل فيكون هكذا:

مثال:
<!-- اكتب تعليقك هنا -->

مثال على تعليق من عدة أسطر

يمكنك أيضًا كتابة تعليق طويل على أكثر من سطر لتوضيح قسم كامل من الكود:

مثال:
<!-- هذا القسم خاص بعرض القائمة الرئيسية ويحتوي على روابط التنقل بين صفحات الموقع --> <nav> <a href=\"#\">الرئيسية</a> <a href=\"#\">من نحن</a> <a href=\"#\">اتصل بنا</a> </nav>

هذا النوع مفيد عندما تريد شرح جزء أكبر من الصفحة.

استخدام التعليقات لتنظيم أقسام الصفحة

في المشاريع الكبيرة، يستخدم المطورون التعليقات لتقسيم الصفحة إلى أجزاء واضحة، مثل الرأس والمحتوى والتذييل:

مثال:
<!DOCTYPE html> <html> <head> <title>تنظيم الصفحة</title> </head> <body>
<!-- بداية الهيدر -->
<header>
    <h1>موقعي الإلكتروني</h1>
</header>

<!-- بداية المحتوى -->
<main>
    <p>هذا هو المحتوى الرئيسي للصفحة.</p>
</main>

<!-- بداية الفوتر -->
<footer>
    <p>جميع الحقوق محفوظة</p>
</footer>
</body> </html>

هذه الطريقة تجعل قراءة الكود أسهل بكثير، خاصة عند زيادة عدد العناصر داخل الصفحة.

تعطيل جزء من الكود مؤقتًا باستخدام التعليقات

من أشهر استخدامات التعليقات في HTML هو إيقاف جزء من الكود مؤقتًا دون حذفه، وذلك أثناء التجربة أو الاختبار.

مثال:
<body> <h1>مرحبًا بك</h1>
<!--
<p>هذه الفقرة تم تعطيلها مؤقتًا.</p>
<button>اضغط هنا</button>
-->

<p>هذه الفقرة ما زالت ظاهرة في الصفحة.</p>
</body>

في المثال السابق، الفقرة والزر داخل التعليق لن يظهرا في الصفحة.

مثال عملي على التعليقات داخل قائمة

مثال:
<ul> <!-- العنصر الأول --> <li>HTML</li>
<!-- العنصر الثاني -->
<li>CSS</li>

<!-- العنصر الثالث -->
<li>JavaScript</li>
</ul>

يمكنك من خلال هذا الأسلوب توضيح ترتيب العناصر أو وظيفتها.

مثال عملي داخل نموذج form

مثال:
<form> <!-- حقل إدخال الاسم --> <label>الاسم:</label> <input type=\"text\" name=\"name\">
<!-- حقل إدخال البريد الإلكتروني -->
<label>البريد الإلكتروني:</label>
<input type=\"email\" name=\"email\">

<!-- زر الإرسال -->
<button type=\"submit\">إرسال</button>
</form>

هذا يفيد بشكل خاص عندما يحتوي النموذج على عدد كبير من الحقول.

أخطاء شائعة عند كتابة التعليقات في HTML

من المهم كتابة التعليقات بالطريقة الصحيحة، لأن أي خطأ قد يؤدي إلى مشاكل في فهم الكود أو في عرضه.

1) نسيان إغلاق التعليق

مثال:
<!-- هذا تعليق غير مغلق <p>نص داخل الصفحة
هذا خطأ، لأن التعليق يجب أن ينتهي بـ `–>`.
2) كتابة التعليق بصيغة غير صحيحة

مثال:
<-- هذا ليس تعليقًا صحيحًا -->

الصحيح هو:

مثال:
<!-- هذا تعليق صحيح -->

3) استخدام التعليقات بشكل مبالغ فيه

الإكثار من التعليقات في كل سطر قد يجعل الكود مزدحمًا. الأفضل أن تستخدمها فقط عند الحاجة، مثل شرح جزء مهم أو تقسيم الصفحة إلى أقسام واضحة.

هل تظهر تعليقات HTML للمستخدم؟

التعليقات لا تظهر داخل الصفحة بشكل مباشر، لكن يمكن لأي شخص عرض مصدر الصفحة في المتصفح ورؤية التعليقات المكتوبة داخل الكود.
لهذا السبب، لا يجب أبدًا وضع معلومات حساسة أو كلمات مرور أو بيانات خاصة داخل التعليقات.

مثال:
<!-- لا تضع هنا معلومات سرية مثل كلمات المرور -->

الفرق بين التعليقات في HTML والتعليقات في لغات أخرى

تعليقات HTML تختلف عن تعليقات CSS وJavaScript.

تعليق HTML

مثال:
<!-- تعليق في HTML -->

تعليق CSS

مثال:
/* تعليق في CSS */

تعليق JavaScript

مثال:
// تعليق في JavaScript

لذلك يجب استخدام الصيغة المناسبة حسب نوع الكود الذي تعمل عليه.

أفضل الممارسات عند استخدام تعليقات HTML

للحصول على كود منظم وواضح، اتبع النصائح التالية:

اكتب تعليقات قصيرة وواضحة.

استخدم التعليقات لتوضيح الأجزاء المعقدة فقط.

قسّم الصفحة إلى أقسام بالتعليقات عند الحاجة.

لا تضع معلومات حساسة داخل التعليقات.

لا تعتمد على التعليقات بدلًا من كتابة كود منظم وواضح.

خلاصة

التعليقات في HTML وسيلة مهمة جدًا تساعدك على تنظيم الكود وشرحه وتسهيل صيانته.
يتم إنشاؤها باستخدام:

مثال:
<!-- نص التعليق -->

ورغم أنها لا تظهر داخل الصفحة للمستخدم، إلا أنها مفيدة جدًا للمطور أثناء كتابة المشروع أو تعديله لاحقًا. كما يمكن استخدامها لتعطيل أجزاء من الكود مؤقتًا أو لتقسيم الصفحة إلى أقسام واضحة ومنظمة.

إذا أردت، أستطيع أيضًا تجهيز لك نسخة منسقة أكثر للنشر في ووردبريس مع عناوين SEO ووصف ميتا ومقدمة احترافية.