عند البرمجة على الكمبيوتر ، في بعض الأحيان يكون من الضروري ترك ملاحظات أو تعليقات حتى يتمكن المطورون الآخرون من تصفح الكود الخاص بك بسهولة. سواء كان مشروعًا مفتوح المصدر أو مشروعًا مملوكًا ، هناك حاجة إلى التعليقات من أجل التنسيق مع المطورين المشاركين والمطورين المستقبليين المحتملين أيضًا. بدون تعليقات ، سيكون الرمز ببساطة غير قابل للاستمرار.
خطوات
الخطوة 1. فهم الغرض من التعليق على برنامج كمبيوتر
- المقروئية هي الشيء الرئيسي هنا. عندما تنظر إلى تعليق ، يجب أن تعلم أنه تعليق وليس سطرًا برمجيًا.
- يجب أن يكون التعليق مفيدًا أيضًا ليس لك فقط ، ولكن لأي شخص آخر قد يقرأ الكود المصدري لبرنامج الكمبيوتر الخاص بك.
الخطوة الثانية: فكر في طريقة قصيرة وبسيطة لتوضيح وجهة نظرك
لا يجب أن تكون التعليقات عملاً فنيًا. يجب أن تكون موجزة وأنيقة ومستقيمة في صلب الموضوع.
ومع ذلك ، لا ينبغي أن يثبط هذا استخدام أسطر متعددة للتعليق. النقطة المهمة هي أن المعلومات يجب أن تصل إلى القارئ
الخطوة 3. اكتب التعليق باستخدام الصيغة المناسبة التي قدمتها لغة البرمجة
الخطوة 4. اسأل نفسك ما إذا كان التعليق الذي كتبته مفصلاً بدرجة كافية
يجب أن يكون التعليق قادرًا على إخبار أي شخص ينظر إلى الكود المصدري بما يفعله هذا الجزء من البرنامج بالفعل دون الحاجة إلى تجميعه وتشغيله. هل تعليقك يحقق هذا؟ هل تنقل كل التفاصيل؟
