Saat menulis scripts Bash, selalu merupakan praktik yang baik untuk membuat kode Anda bersih dan mudah dimengerti. Mengatur kode Anda dalam block, indentasi, pemberian variabel dan fungsi nama deskriptif adalah beberapa cara untuk melakukan ini.

Cara lain untuk meningkatkan keterbacaan kode adalah dengan menggunakan komentar. Komentar adalah penjelasan atau anotasi yang dapat dibaca manusia yang ditulis dalam scripts shell.

Menambahkan komentar ke skrip Bash Anda akan menghemat banyak waktu dan usaha ketika melihat kode Anda di masa depan. Katakanlah Anda ingin mengubah skrip yang Anda tulis beberapa bulan atau tahun yang lalu. Kemungkinan yang sering terjadi adalah Anda tidak ingat mengapa Anda menulis beberapa kode yang rumit kecuali Anda menambahkan komentar.

Komentar tersebut juga membantu pengembang dan administrator sistem lain yang mungkin perlu mempertahankan skrip untuk memahami kode Anda dan tujuannya.

Komentar biasanya digunakan untuk menjelaskan penggunaan kode tersebut. Misalnya, jika Anda memiliki regex kompleks atau parameter subtitusi di dalam skrip Bash, Anda harus menulis komentar tentang apa yang dilakukan kode. Komentar harus singkat dan to the point. Jangan menjelaskan sesuatu yang sederhana dan dipahami secara umum pada pengembang lain.

Di artikel ini, kami akan membahas dasar-dasar menulis komentar di Bash.

Menulis Komentar di Bash

Bash mengabaikan semua yang ditulis setelah tanda pagar (#) di setiap baris. Satu-satunya pengecualian untuk aturan ini adalah ketika baris pertama pada skrip dimulai dengan karakter #!. Urutan karakter ini disebut Shebang dan digunakan untuk memberi tahu sistem operasi penafsir mana yang akan digunakan untuk mem-parsing sisa file.

Komentar dapat ditambahkan di awal baris atau sebaris dengan kode lain:

# Ini adalah komentar.
echo "Ini adalah kode yang di eksekusi" # ini juga komentar.

Ruang kosong setelah tanda pagar tidak wajib, tetapi akan meningkatkan keterbacaan komentar.

Biasanya, ketika skrip dibuka di teks editor , komentar diwakili dalam warna hijau.

Komentar juga bermanfaat saat menguji script. Alih-alih menghapus beberapa baris atau blok, Anda dapat memberi komentar pada kode tersebut :

# if [[ $VAR -gt 10 ]]; then
#  echo "Variabel lebih besar dari 10."
# fi

Komentar Multiline di Bash

Tidak seperti kebanyakan bahasa pemrograman, Bash tidak mendukung komentar multiline.

Cara paling sederhana untuk menulis komentar multiline di Bash adalah menambahkan satu komentar satu demi satu:

# Ini adalah komentar pada baris pertama
# Ini adalah komentar pada baris  kedua

Pilihan lain adalah menggunakan HereDoc. Ini adalah jenis redirect yang memungkinkan Anda untuk menggunakan beberapa baris input ke suatu perintah. Jika blok HereDoc tidak dialihkan ke perintah, ini dapat berfungsi sebagai tempat penampung komentar multiline:

<< 'MULTILINE-COMMENT'
    Apapun yang berada di 
    HereDoc body akan
    menjadi komentar
MULTILINE-COMMENT

Menggunakan HereDoc adalah sebuah tindakan sementara, bukan cara yang baik untuk menulis komentar Bash multiline. Untuk menghindari masalah apa pun, Anda sebaiknya membaut komentar per 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.

Related Post