Arduino/blockcomment

التعليقات هي أسطر توضع في الشيفرة ولا تُنفَّذ بهدف توضيح كيفية عمل البرنامج سواءً لك أو لغيرك. تُهمل هذه الأسطر أينما وُجدَت أثناء تفسير الشيفرة ولا تدخل ضمن البرنامج التنفيذي الذي يُرسَل إلى المتحكم ويُكتَب في ذاكرته. هذا يعني أنها لا تأخذ أية مساحة من ذاكرة البرنامج (الذاكرة flash) في المتحكم. الهدف الوحيد من استعمال التعليقات هو شرح كيفية عمل البرنامج للمساعدة على فهمه وتذكره عندما تطَّلع أنت أو غيرك على شيفرته بعد فترة من الزمن.

تبدأ التعليقات الكتلية (block comment) أو تعليقات الأسطر المتعددة (multi-line comment) بالرمز */ وتنتهي بالرمز /*. يمكن أن يمتد هذا التعليق على عدَّة أسطر بحسب الحاجة؛ ومتى ما قرأ المفسِّر الرمز */، سيتجاهل كل ما كُتِب بعده حتى يصل إلى الرمز /*.

البنية العامة

/* تُكتَب العليقات
 في أسطر
 متعددة هنا
*/

/**
* شكل آخر من
* التعليقات الكتلية
*/

أمثلة

يوضح المثال التالي كيفية استعمال التعليقات الكتلية مع التعليقات السطرية:

/* هذا تعليق كتلي في سطر واحد */

/*
  // الأسطر التالية هي شرح عن البرنامج وعمله ومالكه وتاريخ نشره
  Blink
  Turns on an LED on for one second, then off for one second, repeatedly.

  This example code is in the public domain.
  (Another valid comment)
*/

/*
  if (gwb == 0){   // يمكن استعمال تعليق سطري ضمن تعليق كتلي
  x = 3;           /* ولكن لا يمكن استعمال تعليق كتلي ضمن آخر؛ هذا التعليق خطأ  */
  }
// لا تنسَ إغلاق التعليق الكتلي
*/

ملاحظات وتحذيرات

أثناء تجريب الشيفرة واختبار عملها، يكون تعليق جزء من الشيفرة هو طريقة ملائمة لحذف الأسطر التي يُشَك بأنَّ الخطأ واقعٌ ضمنها. تعليق الأسطر لا يؤدي إلى حذفها بالمعنى الحرفي من الشيفرة بل الإبقاء عليها في الشيفرة وحذفها من الشيفرة التنفيذية المرسلة إلى المتحكم أثناء تفسيرها. هذا الأمر مفيد جدًا ويساعد على تنقيح الشيفرة من الأخطاء وتحصيل مكان الخطأ خصوصًا عندما يرفض المفسِّر تفسير الشيفرة ويرمي خطأَ غير معروف أو مبهم.

انظر أيضًا

• التعبير ‎#define:
• التعبير ‎#define:
• الرمز ;:
• الأقواس {}:
• استعمال التعليقات الكتلية في أردوينو.
• استعمال التعليقات السطرية في أردوينو.

مصادر

• صفحة التعليقات الكتلية في توثيق أردوينو الرسمي.