كتابة التعليقات في البرامج النصية باش

عند كتابة البرامج النصية لـ Bash ، من الأفضل دائمًا جعل التعليمات البرمجية نظيفة وسهلة الفهم. تنظيم التعليمات البرمجية الخاصة بك في كتل ، المسافة البادئة ، إعطاء المتغيرات ووظائف الأسماء الوصفية هي عدة طرق للقيام بذلك.

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

تؤدي إضافة تعليقات إلى البرامج النصية Bash إلى توفير الكثير من الوقت والجهد عندما تنظر إلى الكود في المستقبل. لنفترض أنك تريد تغيير البرنامج النصي الذي كتبته قبل بضعة أشهر أو سنوات. الاحتمالات هي أنك لن تتذكر سبب قيامك بكتابة بعض التعليمات البرمجية المعقدة ما لم تقم بإضافة تعليق.

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

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

سنقوم بتغطية أساسيات كتابة التعليقات في Bash.

كتابة التعليقات في باش

يتجاهل Bash كل ما هو مكتوب بعد علامة التجزئة ( # ) على السطر. الاستثناء الوحيد لهذه القاعدة هو عندما يبدأ السطر الأول في البرنامج النصي بعلامة #! الشخصيات. يُطلق على تسلسل الأحرف هذا اسم Shebang ويستخدم لإخبار نظام التشغيل عن أي مترجم يستخدم لتحليل بقية الملف.

يمكن إضافة التعليقات في البداية على السطر أو تمشيا مع رمز آخر:

# This is a Bash comment. echo "This is Code" # This is an inline Bash comment.

المساحة الفارغة بعد علامة التجزئة ليست إلزامية ، ولكنها ستعمل على تحسين قابلية قراءة التعليق.

عادة ، عندما يتم فتح البرنامج النصي في محرر نص ، يتم تمثيل التعليقات باللون الأخضر.

التعليقات مفيدة أيضًا عند اختبار البرنامج النصي. بدلاً من حذف بعض الخطوط أو الكتل ، يمكنك التعليق عليها:

# if]; then # echo "Variable is greater than 10." # fi

تعليقات متعددة في باش

على عكس معظم لغات البرمجة ، لا يدعم Bash التعليقات متعددة الأسطر.

إن أبسط طريقة لكتابة تعليقات متعددة الأسطر في Bash هي إضافة تعليقات فردية واحدة تلو الأخرى:

# This is the first line. # This is the second line.

خيار آخر هو استخدام HereDoc. إنه نوع من إعادة التوجيه يتيح لك تمرير سطور متعددة من المدخلات إلى أمر ما. إذا لم يتم إعادة توجيه كتلة HereDoc إلى أمر ، فيمكن أن تعمل كعنصر نائب للتعليقات متعدد الأسطر:

<< 'MULTILINE-COMMENT' Everything inside the HereDoc body is a multiline comment MULTILINE-COMMENT

استخدام HereDoc هو اختراق ، وليس طريقة مضمنة حقيقية لكتابة تعليقات Bash متعددة الأسطر. لتجنب أي مشاكل ، يجب أن تفضل استخدام التعليقات ذات سطر واحد.

استنتاج

تعد كتابة التعليقات ممارسة جيدة وتساعد المطورين الآخرين ، بما في ذلك الذات المستقبلية ، على فهم البرنامج النصي. في Bash ، يعتبر كل شيء بعد علامة التجزئة ( # ) وحتى نهاية السطر تعليقًا.

إذا كان لديك أي أسئلة أو تعليقات ، فلا تتردد في ترك تعليق.

محطة باش