التعليقات تعتبر مفيدة للمبربج خصوصاً حين يعود إلى شفرته بعد وقت طويل من كتابتها لأنها تساعده على التذكر، كما أنها تعين الأخرين على فهم الشفرة التي تكتبها ولكن مامدى إلتزامنا بكتابة التعليقات في الشفرة؟ هل تقوم بشرح الشفرة بشكل مفصل أم أنك تترك رؤوس أقلام؟ أم أنك لاتقوم بذلك أصلاً؟
إضافة التعليقات في الشفرة
في غالب أحاول تجنب كتابة التعليقات و ذلك بجعل الشفرة مقروءة بشكل أكبر ,و في بعض الاحيان أترك رؤوس أقلام لنقاط التي قد تكون غامضة و آخرى تحذيرات لشفرة قد تستخدم بشكل خاطئ و أيضا لقائمة المهام (TODO).
أكتبها بشكل مفصل عندما أريد إنشاء توثيق لشفرة باستخدام أحد ادوات لإنشاء التوثيق ( javadoc , pydoc) بتنسيقات مختلفة مثل HTML أو غيرها
التعليقات