التعليقات تعتبر مفيدة للمبربج خصوصاً حين يعود إلى شفرته بعد وقت طويل من كتابتها لأنها تساعده على التذكر، كما أنها تعين الأخرين على فهم الشفرة التي تكتبها ولكن مامدى إلتزامنا بكتابة التعليقات في الشفرة؟ هل تقوم بشرح الشفرة بشكل مفصل أم أنك تترك رؤوس أقلام؟ أم أنك لاتقوم بذلك أصلاً؟
إضافة التعليقات في الشفرة
اكتبها رؤوس رؤوس اقلام، اي انها تكون مختصرة و "احيانا" قد تحتوي على رموز وكلمات قد لايفهمها من ليس ملم بكل جوانب التطبيق وميزاته....
الاجمل من ذلك ان تكون الشفرة هي تشرح نفسها بنفسها، ولا تحتاج الا الجزء اليسير من التعليقات
مثلا "احيانا" اسمي همممم الـ "فعل" "method" هكذا:
اجلب-لي-دجاجتي-السمينة-من-بيت-الدجاج-واحضرها-لهنا-لكي-احضرها-واضعها-في-الفرن-الالي-الذي-يجب-ان-يكون-بدرجة-حرارة-....
اعتمد على فكرة: انا اعمل مبرمج لاكتب تطبيق "code" ليس لاكتب تعليقات، التعليقات اكتبها عندما يكون الصف "class" او همممم الفعل "actoin/method" غير واضحين
التعليقات