مقالة Wulin.com (www.vevb.com) مقدمة: لم أر أي بحث علمي يثبت ذلك ، ولكن في مجال البرمجيات ، يشبه العقيدة أو الاعتقاد المشترك. نظرًا لوجودها ، من المهم كتابة البرامج بسهولة والانتباه إلى النوع القابل للقراءة من التعليمات البرمجية. يمكن تحقيق هذه المتطلبات من خلال بعض التقنيات ، أحدها يكتب تعليقات رمز.
إخلاء المسئولية: ما قلته عن تجنب تعليقات التعليمات البرمجية لا يعني أنني لا أكتب تعليقات ، مما يعني أنني أتجنب كتابة تعليقات التعليمات البرمجية قدر الإمكان ، لكنني ما زلت أكتبها عندما أشعر أن الأمر يستحق ذلك.
نقضي وقتًا أطول في قراءة البرامج أكثر من كتابة البرامج ، ولم أر أي بحث علمي يثبت ذلك ، ولكن في مجال البرمجيات ، يشبه العقيدة أو الاعتقاد الشائع. نظرًا لوجودها ، من المهم كتابة البرامج بسهولة والانتباه إلى النوع القابل للقراءة من التعليمات البرمجية. يمكن تحقيق هذه المتطلبات من خلال بعض التقنيات ، أحدها يكتب تعليقات رمز.
عند الحديث عن تعليقات الكود ، هناك دائمًا نقاش لا حصر له. هل يجب أن نستخدم التعليقات لتوضيح دور الكود الخاص بنا؟ هل يجب أن نركز على تعبير الكود دون الحاجة إلى تعليقات للمساعدة في القراءة؟ كتب جو كونك مدونة عن الحجة - ألا يجب أن تكتب تعليقات. يقول بعض الأشخاص أن التعليمات البرمجية الموثقة جيدًا تعتبر رمزًا جيدًا ، ويقول البعض إنه يجب تجنب التعليقات لأن التعليقات غالبًا ما تستخدم لشرح/إخفاء التعليمات البرمجية السيئة.
في رأيي ، تحت تأثير الكتب ، لضمان أن يكون الرمز أنيقًا وسهلًا لإعادة تشكيله ، يجب علينا تجنب كتابة التعليقات ما لم يكن لدينا سبب وجيه لكتابة التعليقات (مثل الخوارزميات الرياضية) أو بسبب متطلبات الشركة أو العمليات التي نلزم القيام بذلك. فيما يلي خمسة مخاوف بشأن الملاحظات.
حيث أعتقد أن تعليقات التعليمات البرمجية تعمل آثار مضادةالكود المعلق هو رمز جيد هناك مثل هذا القول ، لذلك غالبا ما يضيف الناس تعليقات إلى الرمز لجعل الرمز جميل. إذا أضفنا تعليقات لتفسير الكود ، فهذا يشبه الإشارة: ربما نكتب رمزًا سيئًا. عندما نريد كتابة تعليق ، يجب أن نتساءل عما إذا كان بإمكاننا جعلها أكثر قابلية للقراءة عن طريق تنظيف الكود.
2. سنقضي المزيد من الوقت في الكتابة والحفاظعادة ما تكون التعليقات هي الإصدار الثاني من الكود. نحن في الواقع نكرر أنفسنا عندما نكتب تعليقات للحصول على وظيفة. لقد انتهكنا مبدأ جاف (لا تكرر نفسك). نحن نقضي المزيد من الوقت ونضيف التعقيد. إذا تغيرت المتطلبات ، فيجب أن يتغير الرمز أيضًا ، وإذا كتبنا تعليقات ، فيجب علينا أيضًا تغييرها. لذا قم بتغيير مرتين في الوقت الذي تقضيه. يمكننا استخدام هذا الوقت لتحسين الكود لدينا أو تطوير ميزات جديدة.
3. التعليقات غير قابلة للاختبار والتحقق منهاعندما نقوم بتعديل الكود ، نستخدم المترجمين ، IDES وأدوات اختبار الوحدة للمساعدة ، ولا توجد تعليقات ولا أدوات مماثلة. لا يمكنك الاعتماد على الأدوات أو اختبارات الوحدة للتأكد من استخدامها بشكل صحيح ، وشروح التاريخ ، وما إلى ذلك. بمجرد كتابة تعليق ، لأنه غير قابل للاختلاف ولا يمكنه الانتباه إلى دقته ، سيتم الحفاظ عليه بلا شك.
4. التعليقات غير موثوق بها مقارنة بالرمزعادة عندما يخرج التعليقات والرمز منه ، يصبح أقل جدوى. إذا قرأها مبرمج ، فيمكن تضليل ذلك. حتى بدون مضللة ، تحتاج إلى قراءة رمز المصدر لمعرفة ما تفعله. للحصول على مثال عملي ، إذا كان رئيسنا يحتاجنا إلى إجراء تعديل ، فهل يجب أن ننظر إلى التعليقات أو الرمز؟ بالطبع سوف ننظر في الكود.
5. التعليقات تأخذ الكثير من مساحة الشاشةبعض أساليب التعليقات (مثل تلك أدناه) تأخذ الكثير من الخطوط ، والتي تصبح مشكلة عندما تريد رؤية المزيد من التعليمات البرمجية.
/**
*
* @param title عنوان القرص المضغوط
* param مؤلف مؤلف القرص المضغوط
* param يتتبع عدد المسارات على القرص المضغوط
* param matterinminutes مدة القرص المضغوط في دقائق
*/
public void addcd (عنوان السلسلة ، مؤلف سلسلة ،
مسارات int ، int matterInminutes) {
قرص مضغوط = قرص مضغوط جديد () ؛
cd.title = title ؛
CD.Author = مؤلف ؛
cd.tracks = المسارات ؛
CD.Duration = المدة ؛
cdlist.add (cd) ؛
}