التعليقات في روبي
التعليقات هي نصوص في الشيفرة لا يُنفذها المُفسِّر (Interpreter). نستخدمها لشرح الشيفرة وتوثيقها للمبرمجين الآخرين أو لأنفسنا في المستقبل.
لماذا نستخدم التعليقات؟
- شرح الشيفرة: توضيح ما يفعله جزء معين من الشيفرة
- التوثيق: تسجيل معلومات عن البرنامج ومُنشئه
- تعطيل الشيفرة مؤقتاً: إيقاف تنفيذ أسطر معينة أثناء الاختبار
- التخطيط: كتابة الخطوات قبل كتابة الشيفرة الفعلية
التعليق أحادي السطر
لكتابة تعليق في سطر واحد، نستخدم علامة # (الشباك). كل ما يأتي بعد هذه العلامة في نفس السطر يُعتبر تعليقاً:
الناتج:
لاحظ أن التعليقات لا تظهر في الناتج!
أمثلة على التعليقات أحادية السطر
التعليق متعدد الأسطر
عندما تحتاج لكتابة تعليق طويل يمتد على عدة أسطر، يمكنك استخدام =begin و =end:
قواعد مهمة للتعليقات متعددة الأسطر
- يجب أن تكون
=beginو=endفي بداية السطر تماماً (لا مسافات قبلها) - كل ما بينهما يُعتبر تعليقاً ولا يُنفَّذ
أيهما أستخدم؟
| الحالة | النوع المُفضَّل |
|---|---|
| تعليق قصير | # |
| شرح سطر واحد | # |
| توثيق طويل | =begin...=end |
| تعطيل شيفرة مؤقتاً | # لأسطر قليلة |
في الواقع العملي، معظم مبرمجي روبي يستخدمون # حتى للتعليقات الطويلة:
نصائح لكتابة تعليقات جيدة
- اكتب لماذا وليس ماذا: الشيفرة تُظهر "ماذا" يحدث، التعليق يشرح "لماذا"
- اجعلها محدثة: تعليق قديم أسوأ من عدم وجود تعليق
- اختصر: التعليق الجيد واضح ومختصر
- استخدم العربية أو الإنجليزية باستمرار: اختر لغة واحدة للتعليقات
تعطيل الشيفرة مؤقتاً
أحياناً نريد إيقاف تنفيذ سطر معين لاختبار شيء ما:
الناتج:
تمرين: استخدام التعليقات
حان وقت التطبيق! في محرر الشيفرة على اليسار:
المطلوب: لديك شيفرة تطبع ثلاثة أسطر. أضف تعليقاً قبل السطر الثاني لتعطيله، بحيث يُطبع السطران الأول والثالث فقط.
الناتج المتوقع:
تلميح: ضع علامة
#في بداية السطر الذي تريد تعطيله.
تذكّر: التعليقات الجيدة تجعل الشيفرة أسهل للفهم والصيانة. اعتد على كتابتها منذ البداية!