عندما تقوم بعرض صفحة ويب في مستعرض ، فإنك تشاهد تمثيلًا مرئيًا لما تعرضه هذه القطعة من البرامج (متصفح الويب) استنادًا إلى شفرة صفحة ويب معينة. إذا قمت بعرض هذا الكود المصدري لصفحة الويب ، فسترى مستندًا يتكون من عناصر HTML المختلفة ، بما في ذلك الفقرات والعناوين والقوائم والروابط والصور والمزيد. يتم تقديم كل هذه العناصر بواسطة المتصفح على شاشة الزائر كجزء من عرض موقع الويب. هناك شيء واحد قد تجده في كود HTML لا يتم عرضه على شاشة شخص ما هو ما يعرف بـ "تعليقات HTML".
ما هو التعليق؟
التعليق عبارة عن سلسلة من التعليمة البرمجية داخل HTML أو XML أو CSS لا يتم عرضها أو التصرف بناءً عليها بواسطة المتصفح أو المحلل اللغوي. مكتوب ببساطة في التعليمات البرمجية لتوفير معلومات حول هذا الرمز أو ملاحظات أخرى من مطوري التعليمات البرمجية.
تحتوي معظم لغات البرمجة على تعليقات ، ويتم استخدامها بشكل شائع من قِبل مطور الكود لواحد أو أكثر ، وذلك للسبب التالي:
- وصف وشرح رمز معقدة لشخص قد يضطر إلى العمل عليه في المستقبل - بما في ذلك أنفسهم! قد يعودون إلى الرمز 3 أو 6 من 12 شهرًا أو أكثر ولا يتذكرون لماذا فعلوا شيئًا بطريقة معينة. يمكن أن تساعد التعليقات في الإجابة على أسئلتهم وتذكيرهم بأماكن وجود ذهنهم عند قيامهم بتطوير تلك الصفحة لأول مرة.
- قدّم تفاصيل حول وقت تعديل الشفرة أو مراجعتها. يمكن أن يكون هذا معلومات مفيدة ويتصرف إلى حد ما مثل سجل تطوير عندما تم تشغيل آخر موقع على.
- أزل أجزاء من الشفرة ، ولكن اتركها متاحة للاستخدام في وقت لاحق. ويتم ذلك غالبًا أثناء اختبار الموقع وتصحيح الأخطاء. إذا كانت لديك مشكلة على أحد المواقع ولم تكن متأكدًا مما يسببها ، يمكنك التعليق على الأقسام في وقت واحد لحظر المشكلة وتحديدها ، ثم العمل على حل المشكلات التي تواجهك.
- دردش مع مطورين آخرين يعملون على الشفرة. من المحتمل أن يتم ذلك أثناء التطوير كطريقة لمشاركة التفاصيل مع الآخرين الذين يعملون على الشفرة في نفس الوقت. إذا كانت هذه التعليقات عبارة عن محادثات تطويرية بحتة ، فمن الأفضل إزالتها من الشفرة قبل إطلاق الموقع.
تقليديا ، يتم استخدام التعليقات في HTML لأي عنصر تقريبًا ، بدءًا من تفسيرات هياكل الطاولات المعقدة وحتى الملاحظات المفيدة لمحتوى الصفحة نفسها. نظرًا لأن التعليقات لا يتم عرضها في المتصفح ، يمكنك إضافتها في أي مكان في HTML ولا تقلق بشأن ما ستفعله عندما يتم عرض الموقع من قبل أحد العملاء.
كيف تكتب التعليقات
كتابة التعليقات في HTML و XHTML و XML أمر سهل للغاية. ببساطة قم بإحاطة النص الذي تريد التعليق عليه بما يلي:
و
كما ترى ، تبدأ هذه التعليقات بـ "أقل من رمز" ، بالإضافة إلى نقطة تعجب وشرطتين. ينتهي التعليق بشرطتين إضافيتين و "أكبر من: الرمز. بين تلك الحروف يمكنك كتابة ما تريد أن تشكل نص التعليق.
في CSS ، يختلف الأمر قليلاً ، باستخدام التعليقات البرمجية C بدلاً من HTML يمكنك البدء بشرطة مائلة متبوعة بعلامة النجمة. يمكنك إنهاء التعليق بعكس ذلك ، وهي علامة نجمية متبوعة بخط مائل للأمام.
التعليقات هي فن يحتضر
يعرف معظم المبرمجين قيمة التعليقات المفيدة. التعليمات البرمجية المعلقة تجعل من السهل نقل هذا الرمز من عضو فريق إلى آخر. تساعد التعليقات فريق ضمان الجودة على اختبار الشفرة لأنها تستطيع معرفة ما يقصده المطور - حتى لو لم يتحقق ذلك. لسوء الحظ ، مع شعبية منصات تأليف مواقع الويب مثل Wordpress ، والتي تسمح لك بالظهور مع موضوع مختار يتعامل مع الكثير ، إن لم يكن كل ، من HTML بالنسبة لك ، لا يتم استخدام التعليقات في كثير من الأحيان من قبل فرق الويب. هذا لأن التعليقات يصعب رؤيتها في معظم أدوات التأليف المرئية إذا كنت لا تعمل مباشرةً مع الشفرة. على سبيل المثال ، بدلاً من رؤية ، في الجزء العلوي من صفحة ويب:
تعرض الأداة المرئية رمزًا صغيرًا للإشارة إلى وجود تعليق. إذا لم يفتح المصمم التعليق فعليًا ، فقد لا يراه أبدًا. وفي حالة الصفحة أعلاه ، يمكن أن تتسبب في حدوث مشكلات إذا قامت بتحرير الصفحة وأن الكتابة المكتوبة في النص المذكور في التعليق.
ماذا يمكن ان يفعل؟
- اكتب تعليقات مفيدة ومفيدة. لا تتوقع من الآخرين قراءة تعليقاتك إذا كانت طويلة جدًا أو لا تتضمن معلومات مفيدة.
- كمطور ، يجب عليك دائما مراجعة أي تعليقات تراها على الصفحة.
- استخدم الأدوات التي توفرها برامج التأليف التي تسمح لك بإضافة تعليقات.
- استخدم إدارة المحتوى للتحكم في كيفية تحرير الصفحات.
حتى لو كنت الشخص الوحيد الذي يقوم بتحرير صفحات الويب الخاصة بك ، يمكن أن تكون التعليقات مفيدة. إذا قمت فقط بتحرير صفحة معقدة مرة واحدة في السنة ، فمن السهل أن تنسى كيف قمت ببناء الجدول أو وضع CSS. مع التعليقات ، ليس عليك أن تتذكر ، كما هو مكتوب هناك.
