درس التعليقات

ا السلام عليكم و رحمة الله و بركاته

ان كاتب أي برنامج يحتاج في بعض الأحيان أن يضيف بعض التعليقات و الملاحظات الخاصة به و التي لا يريد ان يتم تنفيذها في برنامجه.

------------------------------------------------------
ما هي التعليقات:
------------------------------------------------------

انها الأسطر التي يتجاهلها مترجم الجافا، و لكنها تجعل الكود أسهل قراءة للمبرمج نفسه. بعبارة اخرى انها مجموعة الملاحظات التي يضعها المبرمج في كوده لتسهيل قراءته.


------------------------------------------------------
أنواع التعليقات في الجافا:
------------------------------------------------------

يمكننا ان نضع ملاحظاتنا في برامج الجافا بثلاثة طرق:

التعليق بسطر واحد:



كما هو موضح في الشكل، فإن هذا النوع من التعليق يتم بوضع علامتي (//) قبل السطر المراد تعليقه. و هذا يعني أن يتجاهله المترجم تماماً. و لكنه بالطبع يقوم بتوضيح بعض الأمور للمبرمج. فأنت مثلاً و انت تنظر للصورة تعرف ان الرقم 100 الموجود في الأسفل يمثل ال total الذي يتحدث عنه المبرمج. و هذا بالطبع يعني شيئاً ما للبرنامج



أما في هذا الشكل، فقد تم اضافة التعليق في نهاية بعض الأسطر. و هذا يسهّل الأمور. لأن المترجم سيقوم بتنفيذ البرنامج حتى يصل لعلامتي (//) عندها سيتجاهل بقية السطر، و سينتقل لتنفيذ السطر التالي.

التعليق بعدة أسطر:



نلاحظ هنا أنه تم حجز عدد من الأسطر بين (*/) و (/*).
و هذا يعني ان هذه الأسطر هي عبارة عن تعليق. و لن يتم تنفيذها في البرنامج، و لكنها وضعت للتوضيح.

ان رؤية المترجم لـ (*/) تجعله يتجاهل كل ما يقابله حتى يصل لعلامة (/*) و يقوم بتنفيذ ما يليها.

التعليق بهدف اضافة معلومات لملفات المساعدة:

توفر الـ SDK أداة رائعة لإنشاء ملفات المساعدة و هي javadoc. و ان استدعاء هذا الأمر على أي ملف جافا، يقوم بانشاء عدد من ملفات المساعدة بصيغة الهتمل. و سنتعرض لهذا بالتفصيل ان شاء الله في الدروس الختامية لهذه السلسلة. ما يهمنا الآن هو ان ملفات المساعدة هذه سيتم انشاؤها بناءاً على المعلومات الموجودة و التي قمت أنت بتوفيرها في برنامجك. لذا فقد فلابد من كتابة هذا النوع من التعليقات بصيغة محددة، حتى يتم تضمينها ضمن ملفات المساعدة.



كما ترى في الصورة فقد تم حصر التعليق بين (**/) و (/*) و هذا يعني ان هذه العبارة ستكون خاصة بالتعليق الذي سيظهر في ملفات المساعدة.

نلاحظ في هذا النوع من التعليقات انه يجب ان تسبق بعض المكونات المحددة في البرنامج، و انها توضح بعض الامكانات لها.


------------------------------------------------------
الخاتمة:
------------------------------------------------------

ان التعليقات في أي برنامج تساهم في توضيحه و تجعل قراءته أسهل. و اذا كنت تنوي ان تكون مبرمجاً محترفاً، فلا تجعل تهمل التعليقات أبداً. بل و لابد أن تجعل كودك أسهل و أسهل بجعل الكود يتكلم عن نفسه بأن تستخدم اسماء واضحة للمتغيرات و الفئات.

خاتمة القول، استخدم العليق كلما بدا ذلك ضرورياً. و لا تنسى أن شيئاً يبدو واضحاً و بديهياً الآن قد لا يبدو كذلك بعد اربعة أو خمسة أسابيع.

أرجو أن يكون الدرس واضحاً.

مع تحياتي
محمد عبد الله القيصر