نوشتن نظرات در اسکریپت های Bash

هنگام نوشتن اسکریپت های Bash، همیشه تمرین خوبی است که کد خود را تمیز و به راحتی قابل درک کنید. شما می توانید با سازماندهی کد در بلوک ها، استفاده از تورفتگی و دادن نام های توصیفی به متغیرها و توابع به این هدف دست یابید.

راه دیگر برای بهبود خوانایی کدتان استفاده از نظرات است. نظر یک توضیح یا حاشیه نویسی قابل خواندن برای انسان است که در اسکریپت پوسته نوشته شده است.

افزودن نظرات به اسکریپت‌های Bash باعث صرفه‌جویی در وقت و تلاش شما در آینده می‌شود. برای مثال، اگر می‌خواهید اسکریپتی را که ماه‌ها یا سال‌ها پیش نوشته‌اید تغییر دهید، ممکن است به خاطر نداشته باشید که چرا یک قطعه کد خاص را نوشته‌اید، مگر اینکه یک نظر اضافه کنید. بنابراین، افزودن نظرات به کد می تواند به شما در درک بهتر آن کمک کند و تغییرات بعدی را بدون دردسر انجام دهید.

نظرات همچنین به سایر توسعه دهندگان و مدیران سیستم که ممکن است نیاز به حفظ اسکریپت برای درک کد شما و هدف آن داشته باشند، کمک می کند.

از نظرات برای توضیح کد استفاده می شود. به عنوان مثال، اگر یک regex پیچیده یا جایگزینی پارامتر در داخل اسکریپت Bash خود دارید، باید یک نظر بنویسید و توضیح دهید که کد چه کار می کند. نظرات باید کوتاه و دقیق باشد. از توضیح چیزی که قبلاً برای خواننده واضح و سرراست است خودداری کنید.

در این مقاله به اصول نوشتن نظرات در Bash می پردازیم.

نوشتن نظر در Bash

Bash همه چیز نوشته شده را نادیده می گیرد روی خط بعد از علامت هش (#). تنها استثنای این قانون زمانی است که خط اول اسکریپت با علامت شروع می شود #! شخصیت ها. این دنباله از کاراکترها Shebang نام دارد و به سیستم عامل می گوید که از کدام مفسر برای تجزیه بقیه فایل استفاده کند.

نظرات را می توان در ابتدای خط یا به صورت خطی با کدهای دیگر اضافه کرد:

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

فضای خالی بعد از علامت هش اجباری نیست، اما خوانایی نظر را بهبود می بخشد.

اگر ویرایشگر متن شما از برجسته سازی نحو پشتیبانی می کند، نظرات معمولاً به رنگ سبز نشان داده می شوند.

نظرات همچنین هنگام آزمایش یک اسکریپت مفید هستند. به جای حذف برخی از خطوط یا بلوک ها، می توانید آنها را نظر دهید:

# if [[ $VAR -gt 10 ]]; then
#  echo "Variable is greater than 10."
# fi

نظرات چند خطی در Bash

بر خلاف بسیاری از زبان های برنامه نویسی، 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، همه چیز بعد از علامت هش (#) و تا آخر خط به عنوان نظر در نظر گرفته می شود.

اگر سوال یا بازخوردی دارید، در کامنت بگذارید.