Saat menulis skrip Bash, selalu merupakan praktik yang baik untuk membuat kode Anda bersih dan mudah dimengerti. Mengatur kode Anda dalam blok, membuat indentasi, memberi variabel, dan nama deskriptif fungsi adalah beberapa cara untuk melakukannya.
Cara lain untuk meningkatkan keterbacaan kode Anda adalah dengan menggunakan komentar. Komentar adalah penjelasan atau anotasi yang dapat dibaca manusia yang ditulis dalam skrip shell.
Menambahkan komentar ke skrip Bash Anda akan menghemat banyak waktu dan tenaga saat Anda melihat kode Anda di masa mendatang. Katakanlah Anda ingin mengubah skrip yang Anda tulis beberapa bulan atau tahun yang lalu. Kemungkinan besar Anda tidak akan ingat mengapa Anda menulis beberapa bagian kode yang rumit kecuali Anda menambahkan komentar.
Komentar juga membantu pengembang dan administrator sistem lain yang mungkin perlu memelihara skrip untuk memahami kode Anda dan tujuannya.
Komentar digunakan untuk menjelaskan kode. Misalnya, jika Anda memiliki regex kompleks atau substitusi parameter di dalam skrip Bash Anda, Anda harus menulis komentar yang menjelaskan apa yang dilakukan kode tersebut. Komentar harus singkat dan to the point. Jangan menjelaskan sesuatu yang sederhana dan jelas bagi pembaca.
Dalam artikel ini, kita akan membahas dasar-dasar menulis komentar di Bash.
Menulis Komentar di Bash #
Bash mengabaikan semua yang tertulis di baris setelah tanda pagar (# ). Satu-satunya pengecualian untuk aturan ini adalah ketika baris pertama pada skrip dimulai dengan #! karakter. Urutan karakter ini disebut Shebangand digunakan untuk memberi tahu sistem operasi penerjemah mana yang akan digunakan untuk mengurai sisa file.
Komentar dapat ditambahkan di awal baris atau sebaris dengan kode lain:
# This is a Bash comment.
echo "This is Code" # This is an inline Bash comment.
Ruang kosong setelah tanda pagar tidak wajib, tetapi akan meningkatkan keterbacaan komentar.
Jika editor teks Anda mendukung penyorotan sintaks, komentar biasanya ditampilkan dalam warna hijau.
Komentar juga berguna saat menguji skrip. Alih-alih menghapus beberapa baris atau blok, Anda dapat mengomentarinya:
# if [[ $VAR -gt 10 ]]; then
# echo "Variable is greater than 10."
# fi
Komentar Multiline di Bash #
Tidak seperti kebanyakan bahasa pemrograman, Bash tidak mendukung komentar multiline.
Cara paling sederhana untuk menulis komentar multibaris di Bash adalah dengan menambahkan satu komentar satu demi satu:
# This is the first line.
# This is the second line.
Pilihan lain adalah menggunakan HereDoc. Ini adalah jenis pengalihan yang memungkinkan Anda untuk melewatkan beberapa baris input ke sebuah perintah. Jika blok HereDoc tidak dialihkan ke sebuah perintah, blok tersebut dapat berfungsi sebagai placeholder komentar multibaris:
<< 'MULTILINE-COMMENT'
Everything inside the
HereDoc body is
a multiline comment
MULTILINE-COMMENT
Menggunakan HereDoc adalah peretasan, bukan cara bawaan yang nyata untuk menulis komentar Bash multiline. Untuk menghindari masalah apa pun, Anda sebaiknya memilih menggunakan komentar satu baris.
Kesimpulan #
Menulis komentar adalah praktik yang baik dan membantu pengembang lain, termasuk diri sendiri di masa depan, untuk memahami skrip shell. Di Bash, semuanya setelah tanda pagar (# ) dan sampai akhir baris dianggap sebagai komentar.
Jika Anda memiliki pertanyaan atau masukan, jangan ragu untuk memberikan komentar.