Menulis komentar dalam skrip bash

Saat menulis skrip Bash, selalu merupakan praktik yang baik untuk membuat kode Anda bersih dan mudah dimengerti. Mengorganisir kode Anda dalam blok, indentasi, memberikan variabel dan fungsi nama deskriptif adalah beberapa cara untuk melakukan ini.

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

Menambahkan komentar ke skrip Bash Anda akan menghemat banyak waktu dan upaya ketika Anda melihat kode Anda di masa depan. Katakanlah Anda ingin mengubah skrip yang Anda tulis beberapa bulan atau tahun yang lalu. Kemungkinannya adalah Anda tidak akan ingat mengapa Anda menulis beberapa kode yang rumit kecuali jika 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 kode apa yang tidak bisa. Misalnya, jika Anda memiliki regex kompleks atau penggantian parameter di dalam skrip Bash Anda, Anda harus menulis komentar tentang apa yang dilakukan kode. Komentar harus singkat dan to the point. Jangan menjelaskan sesuatu yang sederhana dan jelas kepada pembaca.

, kami akan membahas dasar-dasar penulisan komentar di Bash.

Menulis Komentar di Bash

Bash mengabaikan semua yang ditulis setelah tanda pagar ( # ) di telepon. 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:

# 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.

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

Komentar juga bermanfaat saat menguji naskah. Alih-alih menghapus beberapa baris atau blok, Anda dapat berkomentar:

# if]; 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 multiline di Bash adalah 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 melewati beberapa baris input ke suatu perintah. Jika blok HereDoc tidak dialihkan ke perintah, ini dapat berfungsi sebagai placeholder komentar multiline:

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

Menggunakan HereDoc adalah sebuah peretasan, bukan cara yang nyata untuk menulis komentar Bash multiline. Untuk menghindari masalah apa pun, Anda sebaiknya menggunakan komentar satu baris.

Kesimpulan

Menulis komentar adalah praktik yang baik dan membantu pengembang lain, termasuk diri masa depan, untuk memahami skrip shell. Di Bash, semuanya setelah tanda pagar ( # ) dan sampai akhir baris dianggap sebagai komentar.

Jika Anda memiliki pertanyaan atau umpan balik, jangan ragu untuk meninggalkan komentar.

terminal bash