علق بشكل صحيح لغة البرمجة يعد الترميز جزءًا مهمًا من صفحة ويب جيدة التصميم. من السهل إضافة هذه التعليقات ، وسوف يشكرك أي شخص مضطر للعمل على كود هذا الموقع في المستقبل (بما في ذلك أنت أو أعضاء أي فريق تعمل معه) على هذه التعليقات.
كيفية إضافة تعليقات HTML
يمكن تأليف HTML باستخدام محرر نصوص قياسي ، مثل Notepad ++ لنظام التشغيل Windows أو TextEdit لنظام التشغيل Mac. يمكنك أيضًا استخدام برنامج يركز على تصميم الويب مثل Adobe Dreamweaver أو حتى نظام أساسي CMS مثل Wordpress أو ExpressionEngine. بغض النظر عن الأداة التي تستخدمها لتأليف HTML ، إذا كنت تعمل مباشرةً مع الكود ، يمكنك إضافة تعليقات HTML مثل هذا:
أضف الجزء الأول من علامة تعليق HTML:
بعد ذلك الجزء الافتتاحي من التعليق ، اكتب أي نص ترغب في ظهوره لهذا التعليق. من المحتمل أن تكون هذه تعليمات لمطورك أو لمطور آخر في المستقبل. على سبيل المثال ، إذا كنت تريد تحديد مكان بدء أو انتهاء قسم معين في الصفحة في الترميز ، فيمكنك استخدام تعليق لتفصيل ذلك.
بمجرد اكتمال نص تعليقك ، أغلق علامة التعليق كما يلي:
إذن في المجمل ، سيبدو تعليقك كما يلي:
انها حقا بهذه البساطة.
عرض التعليقات
ستظهر أي تعليقات تضيفها إلى كود HTML الخاص بك في هذا الرمز عندما يقوم شخص ما بذلك يعرض مصدر صفحة الويب أو يفتح HTML في محرر لإجراء بعض التغييرات. ومع ذلك ، لن يظهر نص التعليق هذا في متصفح الويب عندما يأتي الزوار العاديون إلى الموقع. على عكس عناصر HTML الأخرى ، بما في ذلك الفقرات أو العناوين أو القوائم ، التي تؤثر فعليًا على الصفحة داخل تلك المتصفحات ، فإن التعليقات هي في الحقيقة أجزاء "خلف الكواليس" من الصفحة.
تعليقات لأغراض الاختبار
نظرًا لأن التعليقات لا تظهر في مستعرض الويب ، فيمكن استخدامها "لإيقاف" أجزاء من الصفحة أثناء اختبار الصفحة أو تطويرها. إذا أضفت الجزء الافتتاحي للتعليق مباشرةً قبل جزء صفحتك / الرمز الذي تريد إخفاءه ، ثم أضفت إغلاق الجزء في نهاية هذا الرمز (يمكن أن تمتد تعليقات HTML على عدة أسطر ، بحيث يمكنك فتح تعليق على السطر 50 من التعليمات البرمجية الخاصة بك و أغلقه في السطر 75 دون مشاكل) ، فلن يتم عرض عناصر HTML التي تقع ضمن هذا التعليق في ملف المتصفح. ستبقى في التعليمات البرمجية الخاصة بك ، لكنها لن تؤثر على العرض المرئي للصفحة. إذا كنت بحاجة إلى اختبار صفحة لمعرفة ما إذا كان قسم معين يسبب مشاكل ، وما إلى ذلك ، فإن التعليق على هذه المنطقة هو الأفضل لحذفها. مع التعليقات ، إذا ثبت أن قسم الكود المعني ليس هو المشكلة ، فيمكنك بسهولة إزالة أجزاء التعليق وسيتم عرض هذا الرمز مرة أخرى. فقط تأكد من أن هذه التعليقات المستخدمة للاختبار لا تصل إلى مواقع الإنتاج. إذا كان يجب عدم عرض منطقة من الصفحة ، فأنت تريد إزالة الرمز ، وليس مجرد التعليق عليه ، قبل بدء تشغيل هذا الموقع.
أحد الاستخدامات الرائعة لتعليقات HTML أثناء التطوير هو عندما تقوم بالبناء موقع ويب سريع الاستجابة. لأن الأجزاء المختلفة من هذا الموقع ستغير مظهرها بناءً على شاشة بأحجام مختلفة، بما في ذلك بعض المناطق التي قد لا يتم عرضها على الإطلاق ، فإن استخدام التعليقات لتبديل أقسام الصفحة أو إيقاف تشغيلها يمكن أن يكون خدعة سريعة وسهلة الاستخدام أثناء التطوير.
بخصوص الأداء
لقد رأيت بعض محترفي الويب يقترحون تجريد التعليقات من ملفات HTML و CSS لتقليل حجم هذه الملفات وإنشاء صفحات يتم تحميلها بشكل أسرع. بينما أوافق على أن الصفحات يجب أن تكون الأمثل للأداء ويجب أن يتم التحميل بسرعة ، فلا يزال هناك مكان للاستخدام الذكي للتعليقات في التعليمات البرمجية. تذكر أن هذه التعليقات تهدف إلى تسهيل العمل على موقع ما في المستقبل ، طالما أنك لا تفرط في ذلك التعليقات المضافة إلى كل سطر في التعليمات البرمجية الخاصة بك ، يجب أن يكون المقدار الصغير لحجم الملف المضاف إلى الصفحة بسبب التعليقات أكبر من مقبول.
نصائح لاستخدام التعليقات
بعض الأشياء التي يجب مراعاتها أو تذكرها عند استخدام تعليقات HTML:
- يمكن أن تكون التعليقات متعددة الأسطر.
- استخدم التعليقات لتوثيق تطوير صفحتك.
- يمكن للتعليقات أيضًا أن توثق المحتوى أو صفوف الجدول أو الأعمدة أو تعقب التغييرات أو أي شيء تريده.
- التعليقات التي "تطفئ" مناطق من الموقع لا يجب أن تدخل حيز الإنتاج ما لم يكن هذا التغيير ملفًا رسالة مؤقتة سيتم عكسها في وقت قصير (مثل تشغيل رسالة تنبيه أو إيقاف تشغيلها كـ بحاجة).