يمكن أن يساعدنا أسلوب الترميز الجيد في الحصول على أفكار واضحة عند إنشاء صفحات الويب، كما تحتوي تعليقات التعليمات البرمجية أيضًا على بعض المعرفة الصغيرة.
لقد قمت بتلخيص معايير كتابة التعليقات التوضيحية التي استخدمتها في عملي، وفي الواقع لا يوجد محتوى تقني، والشيء الرئيسي هو الاهتمام بالمعايير، مما يسهل طريقة الإنتاج الموحدة ويسهل الصيانة.
تتضمن هذه التجارب أربعة أجزاء: "تعليقات المنطقة"، و"تعليقات السطر الواحد"، و"مستويات التعليق"، و"التعليقات المساعدة". ستبدأ طريقة التعليق التوضيحي للمنطقة التي يستخدمها معظم الأصدقاء بـ "محتوى التعليق التوضيحي" أو "نهاية محتوى التعليق التوضيحي"، أو "البدء" أو "النهاية"، وما إلى ذلك. وبالمقارنة، قد يكون البدء بـ "S" أو "E" أسرع استخدم، على سبيل المثال، ما عليك سوى كتابة بداية التعليق أو إنهائه مرة واحدة، ثم انسخه، وقم بتغيير "S" أو "E" لإكمال التعليق بسرعة في المنطقة.
في العمل الفعلي، من غير الواضح في بعض الأحيان ما إذا كان يجب أن يكون التعليق التوضيحي أعلى أو أسفل التسمية. لتجنب هذا الموقف، تتم كتابة معلومات التعليق التوضيحي بشكل موحد قبل وبعد بداية ونهاية تسمية المنطقة، ويسبقها "S". يبدأ " أو
"
E" للإشارة إلى بداية أو نهاية التعليق التوضيحي للمنطقة.مثال:
<!--=محتوى تعليق S-->
<ديف>
...
</div>
<!--=محتوى التعليق الإلكتروني-->
/*=محتوى التعليق الإلكتروني*/
.فصل{
...
}
.فصل{
...
}
/*=E محتوى التعليق*/
التعليق ذات السطر الواحد
في منطقة المحتوى التي تحتاج إلى التعليق عليها
مثال:
<div>
<!--محتوى التعليق-->
...
</div>
.class{
/*محتوى التعليق*/
...
}
مستوى التعليق التوضيحي
في إنتاج الوحدة، قد تكون هناك مناطق داخل المناطق من أجل التمييز بشكل أفضل بين المستويات بين المناطق، تم تقديم مفهوم مستوى التعليق التوضيحي. تشير علامة المساواة الموجودة أمام تعليق المنطقة إلى مستوى التعليق الحالي
مثال:
<!--=S comment content-->
...
<!--==محتوى تعليق S-->
...
<!--===محتوى تعليق S-->
...
<!--===E محتوى التعليق-->
...
<!--==E محتوى التعليق-->
...
<!--=محتوى التعليق الإلكتروني-->
/*=محتوى التعليق الإلكتروني*/
...
/*==محتوى التعليق*/
...
/*===محتوى التعليق*/
...
/*===محتوى التعليق الإلكتروني*/
...
/*==محتوى التعليق الإلكتروني*/
...
/*=E محتوى التعليق*/
المساعدة في التعليق على
معلومات التعريف مثل وقت التعديل والمعدل المضاف عند الاحتفاظ به من قبل غير المؤلفين. أضف المُعدِّل ووقت التعديل والمعلومات الأخرى بناءً على تعليق المنطقة أو التعليق المكون من سطر واحد.
مثال (تعليق المنطقة):
<!--==محتوى تعليق S [المعدل ووقت التعديل]-->
<ديف>
...
</div>
<!--==E محتوى التعليق [المعدل ووقت التعديل]-->
/*=S محتوى التعليق [المعدل ووقت التعديل]*/
.فصل{
...
}
.فصل{
...
}
/*=E محتوى التعليق [المعدل ووقت التعديل]*/
مثال (تعليق من سطر واحد):
<div>
<!-- محتوى التعليق [المعدل ووقت التعديل]-->
...
</div>
.class{
/*محتوى التعليق [المعدل ووقت التعديل]*/
...
}