نصائح

باستخدام التعليقات في روبي

باستخدام التعليقات في روبي

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

من الجيد عادة وضع التعليقات أمام الفصول والأساليب وأي جزء من التعليمات البرمجية قد يكون معقدًا أو غير واضح.

استخدام التعليقات بفعالية

يجب استخدام التعليقات لإعطاء معلومات أساسية أو التعليق على التعليمات البرمجية الصعبة. الملاحظات التي توضح ببساطة ما يفعله السطر التالي من التعليمات البرمجية المباشرة ليست واضحة فحسب ، بل تضيف أيضًا فوضى إلى الملف.

من المهم الحرص على عدم استخدام الكثير من التعليقات والتأكد من أن التعليقات المقدمة في الملف مفيدة ومفيدة للمبرمجين الآخرين.

شيبانج

ستلاحظ أن جميع برامج Ruby تبدأ بتعليق يبدأ بـ #!. وهذا ما يسمى أ كوخ ويستخدم على أنظمة Linux و Unix و OS X.

عندما تقوم بتنفيذ برنامج نصي Ruby ، ​​ستبحث shell (مثل bash على Linux أو OS X) عن shebang في السطر الأول من الملف. ستستخدم shell ثم shebang للعثور على مترجم Ruby وتشغيل البرنامج النصي.

المفضل روبي شيبانج هو #! / usr / bin / env ruby، على الرغم من أنك قد ترى أيضا #! / البيرة / بن / روبي أو #! / البيرة / المحلية / بن / روبي.

تعليقات سطر واحد

تعليق روبي ذو سطر واحد يبدأ بـ # حرف وينتهي في نهاية السطر. أي شخصيات من # يتم تجاهل الحرف إلى نهاية السطر بالكامل بواسطة مترجم روبي.

ال # ليس بالضرورة أن تحدث الشخصية في بداية السطر ؛ يمكن أن يحدث في أي مكان.

يوضح المثال التالي بعض استخدامات التعليقات.

#! / usr / bin / env ruby

# يتم تجاهل هذا الخط بواسطة مترجم روبي

# هذه الطريقة تطبع مجموع حججها

مبلغ def (a ، b)

يضع + ب

النهاية

المجموع (10،20) # اطبع مجموع 10 و 20

متعدد الخطوط تعليقات

على الرغم من نسيان كثير من المبرمجين في روبي ، إلا أن روبي لديه تعليقات متعددة الخطوط. تعليق متعدد الأسطر يبدأ بـ = تبدأ الرمز المميز وينتهي مع = نهاية رمزية.

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

#! / usr / bin / env ruby

= تبدأ

بين = تبدأ و = نهاية ، أي رقم

من الخطوط قد تكون مكتوبة. كل هذه

يتم تجاهل الخطوط من قبل مترجم روبي.

= نهاية

يضع "مرحبا العالم!"

في هذا المثال ، سيتم تنفيذ التعليمات البرمجية كـ مرحبا بالعالم!