شرح صفوف ومحتوى الفقرة
القاعدة الذهبية في هندسة البرمجيات أن يشرح التعليق السبب والغاية (لماذا كُتب هذا الرقم أو الشرط؟) لا أن يعيد سرد الكود الواضح بذاته:
| جودة التعليق | المثال | التقييم الهندسي |
|---|---|---|
| تعليق حشوي مكرر | // Set text to Done | يُتجنب لأنه يكرر حرفياً ما يقوله السطر البرمجي بوضوح |
| تعليق يوضح السبب | // Limit summary to 160 chars for search snippet | ممتاز لأنه يوثق القيد الهندسي وراء اختيار الرقم 160 |