“التعليقات”
Comments هي عبارة عن جمل توضيحية يقوم المبرمج بإضافتها ضمن أي مكان في
المشروع البرمجي أثناء بنائه، وتُعتبر التعليقات كالمفتاح، فهي تهدف إلى
تسهيل قراءة المشروع البرمجي سواءً للشخص الذي قام ببنائه أو حتى لأي شخص
آخر يحاول فهمه أو التعديل عليه.
التعليقات يتم تجاهلها بشكل نهائي أثناء تنفيذ المشروع البرمجي حتى وإن كانت تحتوي على أكواد برمجية، فهي لا تظهر نهائيًا ولا يستطيع رؤيتها إلا من يحصل على ملفات المشروع البرمجي.
ولتبسيط فهم فوائد التعليقات في لغات البرمجة لنقل أنك قمت ببناء مشروع برمجي مؤلف من مئة سطر برمجي على سبيل المثال ثم أردت أن تقوم بالتعديل على المشروع بعد فترة زمينه؛ لنقل شهر على سبيل المثال، أليس الأمر بغاية الصعوبة أن تتذكر كل ما قمت بفعله أثناء كتابة مشروعك البرمجي؟ أليس من الصعب البحث في مئة سطر للتعديل على جزء معين؟ ناهيك عمّا إذا كنت قد طرحت المشروع لمبرمجين آخرين لإكمال المشروع البرمجي أو الاعتماد عليه. لهذا السبب وجدت التعليقات ببساطة، لشرح المشروع البرمجي وتقسيمة بطريقة تجعل من التعديل على المشروع أمر بغاية البساطة لأي شخص، حتى وإن لم يكن هو من قام ببناء المشروع من الأساس.
لعلّ السؤال في ذهنك الآن هو كيفية وضع التعليقات في لغات البرمجة المختلفة؟ في الحقيقة تختلف طريقة إضافة التعليقات من لغة لأخرى، ولكن تقريبًا معظم التعليقات في لغات البرمجة مُستمدة من نظام التعليقات في لغتي C و C++، وهو إضافة تعليق بعد شرطتين مائلتين لليسار (//) ثم كتابة التعليق بعد هاتين الشرطتين بهذا الشكل:
وبمجرد النزول لسطر جديد ينتهي التعليق، ونفس هذا النوع من التعليقات الذي ينتهي بمجرد النزول لسطر جديد هو أن نقوم باستخدام الرمز (#)، ومثال على ذلك:
أما النوع الثاني هو للتعليقات الطويلة والتي نقوم بتميزيها، وهو باستخدام
الشرطة المائلة لليسار ثم علامة النجمة لفتح التعليق، ثم نقوم بإغلاق
التعليق عكس الفتح وهو بإضافة علامة النجمة متبوعة بالشرطة المائلة لليسار
ليصبح بالشكل التالي:
تُعتبر إضافة التعليقات أمر يزيد من احترافية العمل الخاص بك حتى وإن كان
المشروع البرمجي الخاص بك بسيط، وعلى الرغم أن لك الحرية المطلقة في إضافة
التعليقات في أي مكان في مشروعك البرمجي ولكن هُناك قواعد عامة يتم
اتّباعها من قبل المبرمجين، هذه القواعد ليست بالضرورة أن تلتزم بها إلا
عندما تقوم بطرح المشروع البرمجي الخاص بك لمبرمجين آخرين، ولعلّ أهم هذه
القواعد هي ما يلي:
وكنصيحة،
حاول دائمًا في أي لغة برمجة تتعلّمها، اجعل من التعليقات أمر مرافق لك في
جميع المشاريع البرمجية التي تقوم ببنائها أثناء التدريب لتعتاد عليها
أثناء بناء مشاريع برمجية مُتكاملة جاهزة للاستخدام.
التعليقات يتم تجاهلها بشكل نهائي أثناء تنفيذ المشروع البرمجي حتى وإن كانت تحتوي على أكواد برمجية، فهي لا تظهر نهائيًا ولا يستطيع رؤيتها إلا من يحصل على ملفات المشروع البرمجي.
ولتبسيط فهم فوائد التعليقات في لغات البرمجة لنقل أنك قمت ببناء مشروع برمجي مؤلف من مئة سطر برمجي على سبيل المثال ثم أردت أن تقوم بالتعديل على المشروع بعد فترة زمينه؛ لنقل شهر على سبيل المثال، أليس الأمر بغاية الصعوبة أن تتذكر كل ما قمت بفعله أثناء كتابة مشروعك البرمجي؟ أليس من الصعب البحث في مئة سطر للتعديل على جزء معين؟ ناهيك عمّا إذا كنت قد طرحت المشروع لمبرمجين آخرين لإكمال المشروع البرمجي أو الاعتماد عليه. لهذا السبب وجدت التعليقات ببساطة، لشرح المشروع البرمجي وتقسيمة بطريقة تجعل من التعديل على المشروع أمر بغاية البساطة لأي شخص، حتى وإن لم يكن هو من قام ببناء المشروع من الأساس.
لعلّ السؤال في ذهنك الآن هو كيفية وضع التعليقات في لغات البرمجة المختلفة؟ في الحقيقة تختلف طريقة إضافة التعليقات من لغة لأخرى، ولكن تقريبًا معظم التعليقات في لغات البرمجة مُستمدة من نظام التعليقات في لغتي C و C++، وهو إضافة تعليق بعد شرطتين مائلتين لليسار (//) ثم كتابة التعليق بعد هاتين الشرطتين بهذا الشكل:
- استخدم كلمات واضحة ومفهومة للجميع في شرح التعليق، ولا تستخدم رموز وطلاسم غير قابلة للفهم.
- استخدم اللغة الإنجليزية وذلك لتسمح لأي شخص بفهم التعليق، لأن اللغة الإنجليزية هي اللغة الأكثر انتشارًا بين لغات العالم.
- أضف التعليقات ليشرح التعليق ما بعده من أكود برمجية، وهذا ما يجعل قراءة السكربت أكثر يسر، ولا تقم بإضافة التعليقات بمناطق عشوائية من المشروع البرمجي لأن هذا الأمر يزيد الوضع تعقيدًا.
- قمّ بتمييز التعليق للأمور المهمة، كأن تقوم بوضع التعليق ضمن صندوق مميز. لاحظ المثال التالي، وهو لتعليق من سكربت PHP. السكربت المستخدم بعد التعليق هو للاتصال بالمخدم ثم اختيار قاعدة البيانات، ولأن هذا الجزء من السكربت أمر مهم جدًا ولن يعمل السكربت ككل إن كان هذا الجزء يحتوي على خلل، قُمنا بتمييز التعليق الخاص به:
لا تقرأ وترحل .. شارك قول رأيك
0 تعليقات: