التعليقات واستخداماتها

التعليقات ما هي الا ملاحظات يتم كتابتها على ضمن ملف الكود يتجاها المصرف (compiler) والمترجم (interpreter) يسهل تضمين التعليقات في الكود من قراءتها وفهمها ومعرفة وظيفة كل جزء من اجزائها لانها توفر معلومات وشروحات حول ما يفعله كل جزء من اجزائها.

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

صياغة التعليقات

   تبدا التعليقات في بايثون بالعلامة # ثم مسافة بيضاء بعدها وتستمر حتى نهاية السطر يشكل عام مثال على التعليق باللون الاحمر مع ملاحظة انه تم تجاهل المسافة البيضاء بواسطة الكاتب ولكن يفضل اضافتها كمرجع اساسي:

صورة رقم 1
صورة رقم 1

بما ان التعليق لا تترجم عند تشغيل البرنامج ولن تظهر معك مطلقا لن ترى اي اشارة للتعليق فالتعليقات توضع في الكود المصدري لكي يقراه الناس وليس للتنفيذ يمكنك رؤية البرنامج التالي كمثال على التعليق:

صورة رقم 2
صورة رقم 2

وهذا شكل التعليق فوق حلقة التكرار (for loop):

صورة رقم 3
صورة رقم 3

يجب ان تحاذي التعليقات السطر التالي لها في نفس المسافة البادئة للكود المراد التعليق عليه بمعنى عندما تبدا التعليق على كود من اول السطر فعليك كتابة التعليق اعلاه في اول السطر وعند وجود مسافة للكود عليك بكتابة التعليق باستخدام نفس المسافة.

صورة رقم 4
صورة رقم 4

الهدف من التعليق هو مساعدة المبرمج او اي شخص اخر يقرا مشروعه او يتعاون معه على فهمه  واذا تعذر صيانه التعليقات او وتحديثها تحديثا صحيحا فان عدم تضمين التعليقات يكون افضل من كتابة تعليق متناقض مع الكود عليك الاجابة عن سؤال لماذا علي كتابة تعليق لانه ما لم يكن الكود معقدا فيس هناك داعي لكتابة تعليق عليه فقط بالنظر يمكنك فهم الكود.

 التعليقات متعددة الاسطر (block comment)

يمكن استخدام التعليقات متعددة الاسطر لتوضيح الاكواد البرمجية التي لا تتوقع ان يكون القارئ على دراية بها وتكتب هذه التعليقات على بداية الكود المراد شرحه طريقة كتابة التعليقات هي بدا كل سطر بعلامة # مع مسافة بيضاء واحدة واذا كنت تريد كتابة اكثر من سطر تقوم بفصلها بسطر مع كتابة نفس الرمز.

في ما يلي مثال على تعليق متعدد الاسطر كتب على الدالة main (ملاحظة فقط انظر الى التعليق وليس الدالة):

صورة رقم 5
صورة رقم 5

 

تستخدم التعليقات متعددت الاسطر عندما يكون الكود غير واضح وتتطلب شرحا شاملا يجب ان تتجنب كتابة التعليقات على الكود وان تثق في المبرمجين الاخرين في فهم الشفرة اذا كنت لا تكتب لجمهور معين.

 

 التعليقات السطرية  (inline comment)

توضع التعليقات السطرية على نفس السطر الذي يكون فيه التعليمات البرمجية ومثل التعليقات الاخرى فان التعليق السطري يبدا بعلامة # ومسافة بيضاء واحدة بشكل عام تكون التعليقات السطرية شبيهة بالتالي:

صورة رقم 6
صورة رقم 6

لا ينبغي الاكثار من التعليقات السطرية ايضا ولكن عندما تكون التعليقات في محلها يمكن ان تكون فعالة لشطرح الاجزاء المهمة وقد تكون فعالة اذا احسسة انك لن تتذكر سطرا من الكود في المستقبل واذا كنت تتعامل مع شخص قد لا يكون على دراية بجميع وجوانب الكود.

على سبيل المثال اذا لم يكن هنالك توضح مسبق على الكود قد لا تكون انت او المتعاون معك على دراية ان العدد التالي ينشئ عددا عقديا لذلك قد ترغب في اضافة تعليق مسبق كما في الصورة.

صورة رقم 7
صورة رقم 7

يمكن ايضا استخدام التعليقات لشرح سبب لفعل ما عند الضرورة وكما ينبغي ان توفر ارشادات مفيدة فقط للشخص الذي يقرا البرنامج كما في الصورة التالية:

صورة رقم 8
صورة رقم 8

التعليقات للاختبار والتنقيح

يمنك ايضا استخدام التعليقات بالاضافة الى التعليق على الكود كاداه لتعطيل جزء من الكود باستخدام نفس العلامة # للاختبار والنتقيح فقد ترغب في جعل احد السطور كتعليق لاختبار الكود لمعرفة موضع الخلل يمكنك التعليق من تجربة بدائل اخرى اثناء الكتابة لمعرفة مكان الخلل على سبيل المثال يمكنك ان تفاضل بين دوال التكرار while و for في الكود حيث يمكنك ان تجعل الاولى كتعليق والثانية للاختبار حتى تجد الافضل لاحظ التعليقات باللون الاحمر حيث تم تعليق الدالة while واستخدام الدالة for كبديل.

صورة رقم 9
صورة رقم 9

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

خلاصة الفصل

تساعدة التعليقات على جعل البرنامج اكثر قابلية للقراءة سواء لك او لغير التعليقات المناسبة وذات الصلة والمفيدة ستسهل عليك قراءة الكود وتجعل التعاون معك في فهم الكود اكثر قيمة.

اترك تعليقاً

لن يتم نشر عنوان بريدك الإلكتروني. الحقول الإلزامية مشار إليها بـ *

هذا الموقع يستخدم Akismet للحدّ من التعليقات المزعجة والغير مرغوبة. تعرّف على كيفية معالجة بيانات تعليقك.