Menulis komen dalam skrip bash

Apabila menulis skrip Bash, selalu menjadi amalan yang baik untuk membuat kod anda bersih dan mudah difahami. Mengatur kod anda dalam blok, indentasi, memberi pemboleh ubah dan fungsi nama deskriptif adalah beberapa cara untuk melakukan ini.

Satu lagi cara untuk meningkatkan kebolehbacaan kod anda adalah dengan menggunakan ulasan. Ulasan adalah penjelasan atau anotasi yang boleh dibaca manusia yang ditulis dalam skrip shell.

Menambah komen pada skrip Bash anda akan menjimatkan banyak masa dan usaha apabila anda melihat kod anda di masa depan. Katakan anda mahu menukar skrip yang anda tulis beberapa bulan atau tahun lalu. Kemungkinannya anda tidak akan ingat mengapa anda menulis sekeping kod rumit melainkan anda menambah komen.

Komen itu juga membantu pemaju dan pentadbir sistem lain yang mungkin perlu mengekalkan skrip untuk memahami kod dan tujuannya.

Komen biasanya digunakan untuk menjelaskan kod yang tidak boleh. Contohnya, jika anda mempunyai regex yang rumit atau penggantian parameter dalam skrip Bash anda, anda harus menulis komen mengenai kod yang dibuat. Komen harus pendek dan ke titik. Jangan terangkan sesuatu yang mudah dan jelas kepada pembaca.

, kami akan merangkumi asas-asas menulis komen di Bash.

Menulis Komen di Bash

Bash mengabaikan semua perkara yang ditulis selepas tanda hash ( # ) pada baris. Satu-satunya pengecualian kepada peraturan ini adalah apabila baris pertama pada skrip bermula dengan #! watak. Urutan aksara ini dipanggil Shebang dan digunakan untuk memberitahu sistem operasi yang digunakan penterjemah untuk mengurai seluruh fail.

Komen boleh ditambah pada permulaan pada baris atau selaras dengan kod lain:

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

Ruang kosong selepas tanda hash tidak wajib, tetapi ia akan meningkatkan pembacaan komen.

Biasanya, apabila skrip dibuka dalam editor teks, komen diwakili dalam warna hijau.

Komen juga berguna apabila menguji skrip. Daripada memotong beberapa baris atau blok, anda boleh memberi komen kepada mereka:

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

Komen Multiline dalam Bash

Tidak seperti kebanyakan bahasa pengaturcaraan, Bash tidak menyokong komen multiline.

Cara paling mudah untuk menulis komen multiline di Bash adalah untuk menambah komen tunggal satu demi satu:

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

Pilihan lain ialah menggunakan HereDoc. Ia adalah sejenis pengalihan yang membolehkan anda melewati pelbagai baris input kepada arahan. Sekiranya blok HereDoc tidak diarahkan ke arahan, ia boleh berfungsi sebagai pemegang tempat komentar multiline:

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

Menggunakan HereDoc adalah hack, bukan cara yang betul untuk menulis komen multiline Bash. Untuk mengelakkan sebarang masalah, anda harus memilih menggunakan ulasan barisan tunggal.

Kesimpulannya

Komen menulis adalah amalan yang baik dan membantu pemaju lain, termasuk masa depan diri, memahami skrip shell. Di Bash, segalanya selepas tanda hash ( # ) dan sehingga akhir baris dianggap sebagai komen.

Jika anda mempunyai sebarang pertanyaan atau maklum balas, jangan ragu untuk meninggalkan komen.

terminal bash