أهلاً بك مرة أخرى أيها المبرمج الفضولي! 🧐✨ في الدروس السابقة، تعلمنا كيف نجعل برامجنا تقوم بأشياء وتعرض لنا النتائج. لكن ماذا لو أردنا أن نكتب ملاحظات داخل الكود نفسه؟ ملاحظات تشرح لنا ماذا يفعل جزء معين من الكود، أو تذكرنا بشيء مهم، أو حتى نترك رسالة لزميل مبرمج يعمل معنا على نفس المشروع؟ هنا يأتي دور التعليقات (Comments) في جافا!

Comments

التعليقات هي نصوص نكتبها داخل ملف الكود، لكن مترجم جافا (javac) يتجاهلها تمامًا! كأنها مكتوبة بحبر سري لا يراه إلا المبرمجون. إنها أداة رائعة لجعل الكود أكثر قابلية للقراءة والفهم، سواء لنفسك في المستقبل أو لأي شخص آخر يقرأ كودك. هيا نكتشف كيف نستخدم هذه الملاحظات السحرية!

لماذا نستخدم التعليقات؟ (Why Use Comments?) 🤔

قد تتساءل، إذا كان المترجم يتجاهلها، فلماذا نكتبها أصلاً؟ التعليقات لها فوائد عظيمة:

1. شرح الكود (Explaining Code): عندما تكتب كودًا معقدًا، يمكن للتعليق أن يشرح ببساطة ماذا يفعل هذا الجزء من الكود أو لماذا كتبته بهذه الطريقة.
2. جعل الكود قابل للقراءة (Making Code Readable): الكود الجيد ليس فقط الذي يعمل، بل الذي يسهل فهمه. التعليقات تساعد في ذلك بشكل كبير.
3. التذكير لاحقًا (Reminders for Later): قد تترك تعليقًا لتذكير نفسك بمهمة يجب القيام بها (مثل // TODO: Add error handling here) أو فكرة لتحسين الكود.

TODO

4. التعاون (Collaboration): عند العمل في فريق، تساعد التعليقات أعضاء الفريق على فهم كود بعضهم البعض.
5. تعطيل جزء من الكود مؤقتًا (Debugging): أحيانًا، قد ترغب في تعطيل سطر أو عدة أسطر من الكود مؤقتًا لاختبار شيء ما دون حذفها. يمكنك تحويل هذه الأسطر إلى تعليقات!

Debugging

باختصار، التعليقات تجعل حياتنا كمبرمجين أسهل وأكثر تنظيمًا!

أنواع التعليقات في جافا 📝

يوجد نوعان رئيسيان من التعليقات في جافا:

1. تعليقات السطر الواحد (Single-line Comments) //

هذا النوع من التعليقات يبدأ بشرطتين مائلتين للأمام (//) ويمتد حتى نهاية السطر. أي شيء يأتي بعد // في نفس السطر يعتبر تعليقًا وسيتجاهله المترجم.

Single-line Comments

//

✨ مثال عملي: تعليقات السطر الواحد ✨

public class SimpleComments {
  public static void main(String[] args) {
    // هذا تعليق يمتد لسطر واحد فقط.
    System.out.println("مرحباً أيها العالم!"); // هذا تعليق آخر بجانب الكود.

    // السطر التالي سيتم تجاهله بالكامل لأنه تعليق:
    // System.out.println("هذا السطر لن يُطبع!");

    int x = 10; // هذا متغير لتخزين رقم (سنتعلمه قريبًا!)
  }
}

لاحظ كيف يمكن وضع التعليق في سطر منفصل أو في نهاية سطر الكود.

2. تعليقات متعددة الأسطر (Multi-line Comments) /* … */

هذا النوع من التعليقات يبدأ بـ /* وينتهي بـ */. كل ما يقع بين هاتين العلامتين (حتى لو امتد لعدة أسطر) يعتبر تعليقًا وسيتجاهله المترجم.

Multi-line Comments

/*

*/

✨ مثال عملي: تعليقات متعددة الأسطر ✨

public class MultiLineDemo {
  public static void main(String[] args) {
    /*
      هذا تعليق يمتد
      لعدة أسطر.
      يمكنك كتابة شرح مفصل هنا
      أو حتى قصة قصيرة إذا أردت!
    */
    System.out.println("جافا تسمح بتعليقات متعددة الأسطر.");

    /* يمكن أيضًا استخدامها لتعطيل كتلة من الكود:
    int y = 5;
    System.out.println("قيمة y هي: " + y);
    */
    System.out.println("الكود المعلق أعلاه لن يتم تنفيذه.");
  }
}

هذا النوع مفيد جدًا لكتابة شروحات طويلة أو لتعطيل أجزاء كبيرة من الكود مؤقتًا أثناء الاختبار.

ملاحظة مهمة عن تعليقات التوثيق (Javadoc comments):

يوجد نوع خاص من التعليقات متعددة الأسطر يبدأ بـ /** وينتهي بـ */. هذه تُسمى “تعليقات التوثيق” وتستخدم لإنشاء توثيق (documentation) رسمي لبرنامجك باستخدام أداة javadoc. سنتطرق إليها في مستويات متقدمة.

Javadoc comments

/**

javadoc

documentation

✨ دورك الآن لتترك بصمتك! هيا اكتب تعليقاتك! ✨

الآن حان دورك لتجربة إضافة ملاحظاتك السحرية إلى الكود! تذكر، التعليقات هي لك وللآخرين لفهم الكود بشكل أفضل.

جرب هذه الأفكار في محرر الأكواد الفارغ أدناه (أو على جهازك ضمن برنامج كتبته سابقًا):

1. اكتب برنامجًا بسيطًا يطبع اسمك، وأضف تعليق سطر واحد فوق أمر الطباعة يشرح ماذا يفعل هذا الأمر.
2. في نفس البرنامج، أضف تعليقًا متعدد الأسطر في بداية الكلاس يشرح الغرض من هذا البرنامج ومن قام بكتابته وتاريخ كتابته (كأنك تكتب معلومات حقوق النشر!).
3. جرب كتابة أمر طباعة، ثم قم بتحويله إلى تعليق سطر واحد لترى كيف يتجاهله المترجم عند تشغيل البرنامج.
4. اكتب كتلة صغيرة من الكود (سطرين أو ثلاثة)، ثم قم بتعليقها بالكامل باستخدام تعليق متعدد الأسطر.

هيا، انطلق واجعل كودك أكثر وضوحًا باستخدام التعليقات! اكتب في المحرر الفارغ أدناه.

بعد كتابة الكود مع التعليقات، إذا كنت تعمل على جهازك، احفظ الملف، ثم قم بترجمته وتشغيله. ستلاحظ أن التعليقات لا تؤثر أبدًا على كيفية عمل البرنامج، ولكنها تجعل الكود أكثر قابلية للقراءة لك!

نصائح لاستخدام التعليقات بفعالية ✅

• لا تفرط في التعليقات البديهية: لا تحتاج إلى تعليق يشرح شيئًا واضحًا جدًا (مثلاً، int i = 0; // assign 0 to i). اجعل تعليقاتك مفيدة وتشرح “لماذا” وليس فقط “ماذا”.
• اجعل التعليقات محدثة: إذا غيرت الكود، تأكد من تحديث التعليقات المتعلقة به لتعكس التغييرات. التعليقات الخاطئة أسوأ من عدم وجود تعليقات!
• استخدم لغة واضحة وموجزة: يجب أن تكون التعليقات سهلة الفهم.
• التعليقات لا تحل محل الكود الجيد: الهدف الأول هو كتابة كود واضح ومفهوم بذاته قدر الإمكان. التعليقات هي مساعدة إضافية.

ملخص فن كتابة الملاحظات اليوم: ✍️✨

• التعليقات (Comments): نصوص يتجاهلها المترجم، تساعد في شرح وفهم الكود.
• تعليقات السطر الواحد: تبدأ بـ // وتمتد حتى نهاية السطر.
• تعليقات متعددة الأسطر: تبدأ بـ /* وتنتهي بـ */، ويمكن أن تمتد عبر عدة أسطر.
• الفوائد: تجعل الكود قابل للقراءة، تساعد في التذكر، تسهل التعاون، وتستخدم في تصحيح الأخطاء.
• اكتب تعليقات مفيدة: ركز على شرح الأجزاء غير الواضحة أو القرارات التصميمية.

أنت مذهل! 🌟 لقد تعلمت اليوم كيف تترك “بصماتك” داخل الكود باستخدام التعليقات. هذه مهارة مهمة جدًا تجعل منك مبرمجًا محترفًا ومنظمًا. تذكر أن الكود الذي تكتبه اليوم قد تقرأه أنت أو شخص آخر بعد شهور أو سنوات، والتعليقات الجيدة ستكون بمثابة دليل ثمين!

في الدرس القادم، سنتعمق في مفهوم أساسي ومثير جدًا في البرمجة وهو “المتغيرات في جافا (Java Variables)” – وهي طريقة لتخزين البيانات واستخدامها في برامجنا. استعد لتخزين أسرارك البرمجية! إلى اللقاء! 👋