كيفية إضافة تعليقات و ماهي أهميتها في البرمجة؟
ما هي التعليقات في البرمجة ؟
التعليقات في البرمجة هي عبارة عن أكواد غير مؤثرة في عمل البرمجية نفسها، بل هدفها تنظيم و توضيح الكود أكثر سواء بشرح ما يعمله بلغتنا نحن البشر أو بالإشارة إليه فقط ، كما تختل أهداف استعماله من مطور إلى آخر .
كما يمكن كتابة هذا الكود بأي لغة تريد سواء العربية أو الصينية ، الفرنسية أو غيرها من اللغات…
ما هي أهمية التعليقات في البرمجة؟
ما لا يعلمه الكثير من المبرمجين المبتدئين، هو أن للتعليقات دورا هاماً في عمل البرمجية و مستقبلها بوجه الخصوص.. فبالرغم من عدم الإختلاف ظاهريا بين الكود المنسق من خلال التعليقات و الغير متضمن لها إلا أن لها أهمية كبيرة سواء من جانب الإحترافية و إرضاء العميل أو من جانب تفادي بعض المشاكل المتوقع حصولها، تمعن في هذه الفوائد جيدا :
- قد تقلل كتابة التعليقات تكلفة المشروع من صيانة و تحديثات لغاية 70% من التكلفة .
- تسهيل قراءة الكود و تنظيمه ليتمكن أي مطور آخر من فهم آلية عمله و التعديل عليه بسهولة .
- بإضافة التعليقات يكون المبرمج غير ملزم بتوضيح ما قام به و شرحه و تفحص الكود خصوصا عند التعامل مع الشركات .
- قد تنسى آلية عمل الكود أو تحتار في فهمه بعد مدة، و كتابة تعليقات تحتوي على ملاحظات أو غيرها سيجعلك تتذكر و تدرك تماما ما ستفعل .
- تساعد في تسريع عملية التعديل علي الشفرة البرمجية إذا كان هنالك خطأ ما .
- كتابة الأكواد و تضمين تعليقات داخلها يوحي بالإحترافية و يجعل من تتعامل معه يشعر بطمئنينة و رضا بهذا العمل المنظم و يكسبك سمعة جيدة .
كيف تتم كتابة التعليقات ؟
تختلف طريقة كتابة التعليقات من لغة برمجة إلى أخرى، و لكن الشيء المشترك هو أن أغلبية لغات البرمجة يمكن فيها استعمال التعليقات و من بين هذه اللغات :
طريقة إضافة تعليق في HTML
لكتابة تعليق في لغة Html يجب على المبرمج إحاطة التعليق بـ <– في بداية التعليق و <!– في نهاية التعليق حتى و إن كان التعليق يشمل سطرا أو أكثر .
مثال :
<html> <body> <!-- هذا هو التعليق --> </body> </html>
طريقة إضافة تعليق في CSS
قد يظن الكثير أن لغة CSS لا تحتوي على تعليقات أو أنها مشابهة لتعليقات HTML لكن هذا خاطىء . فلإدراج تعليق في CSS عليك إحاطة التعليق بـين /* في البداية و */ في النهاية حتى و إن كان مكونا من عدة أسطر .
مثال :
/* هذا هو التعليق */
طريقة إضافة تعليق في Java
تختلف طريقة كتابة التعليقات قليلا عندما نتكلم عن لغة Java الشهيرة ، فهي تتضمن طريقتين يمكن بهما كتابة تعليق:
لكتابة التعليق في سطر برمجي واحد فقط يمكنك اضافة علامة (Double slash) قبل بداية التعليق و رمزها // .
مثال :
// تعليق في سطر واحد
أما عند كتابة تعليق في أكثر من سطر برمجي فعليك كتابته ما بين الرمز /* و الرمز */ عند الإنتهاء و * عن كل سطر بينهما .
مثال :
/* * السطر الأول للتعليق * السطر الثاني * السطر الثالث ... */