Cara Berkomentar di Bash

Pendahuluan

Komentar dalam skrip bash, dan pemrograman secara umum, membantu membuat program lebih mudah dipahami. Ketika sebuah program berjalan, interpreter mengabaikan baris yang dikomentari. Namun, komentar membantu keterbacaan program secara keseluruhan.

Saat melihat kode nanti, ada baiknya untuk memiliki penjelasan deskriptif dan berharga tentang apa yang dilakukan kode tersebut. Mengomentari kode untuk digunakan nanti adalah praktik umum dan merupakan bagian penting dari pemrograman dan skrip bash.

Tutorial ini menunjukkan cara menggunakan komentar dan praktik komentar terbaik dalam skrip bash.

Prasyarat

• Sistem yang menjalankan Linux.
• Akses ke baris perintah/terminal.
• Editor teks, seperti Vi/Vim.

Cara Berkomentar di Bash

Saat menulis skrip bash, teks apa pun setelah tanda hash (# ) menunjukkan awal komentar, dan teks apa pun setelah # di baris yang sama tidak dijalankan.

Saat menggunakan editor teks atau IDE, komentar diwarnai secara berbeda dari kode lainnya. Mereka mudah untuk diperhatikan dan dicari dalam kode yang lebih luas.

Satu-satunya pengecualian adalah shebang (#! ), yang biasanya ada di baris pertama skrip. Shebang memberi tahu sistem operasi penerjemah mana yang akan digunakan untuk kode tersebut.

Komentar sebaris setelah shebang menghasilkan "Tidak ada file atau direktori seperti itu " kesalahan.

Komentar Baris Tunggal dan Bash Sebaris

Komentar baris tunggal dan sebaris dalam skrip bash dimulai dengan tanda hash (# ):

# This is a comment

Ruang tambahan setelah tanda tidak diperlukan. Namun, ini membantu keterbacaan.

Ikuti contoh di bawah ini untuk membuat skrip dengan komentar:

1. Buka terminal (CTRL +ALT +B ) dan buat skrip menggunakan Vi:

vi comment.sh

2. Tambahkan kode berikut:

# A comment is considered a single line if you do not press Enter. Below is the shebang, indicating the script uses the bash shell.
#!/bin/bash
# This is a single line comment above a command.
echo "Hello world!" # This is an inline comment.
# This is a single line comment below a command.

Script mencakup baris berikut:

• Baris 1 adalah komentar Bash satu baris. Secara visual, pernyataan tersebut terbentang dalam dua baris.
• Baris 2 adalah shebang. Script dijalankan menggunakan penerjemah Bash shell, yang terletak di /bin/bash .
• Baris 3 dan 5 juga merupakan komentar satu baris sebelum dan sesudah perintah.
• Baris 4 adalah perintah echo sederhana dengan komentar sebaris.

3. Simpan dan tutup Vi:

:wq

4. Ubah izin skrip menjadi executable:

chmod +x comment.sh

5. Terakhir, jalankan skrip dengan:

./comment.sh

Komentar tidak ditampilkan saat menjalankan skrip .

Komentar Multiline dan Blokir Bash

Untuk membuat komentar bash multiline, awali setiap baris dengan tanda hash (# ):

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

Cara lain yang tidak konvensional untuk membuat komentar blok multibaris adalah dengan menggunakan perintah bash null (: ) bersama dengan notasi heredoc:

: << 'COMMENT'
This is the first line
This is the second line
COMMENT

Pada dasarnya, bash tidak mendukung komentar blokir. Metode ini berfungsi sebagai peretasan jika komentar blokir penting untuk kasus tertentu.

Coba contoh di bawah ini untuk melihat cara kerja komentar multibaris dan blok di skrip bash:

1. Buka terminal (CTRL +ALT +B ) dan buat skrip shell menggunakan Vi:

vi multiline.sh

2. Salin dan tempel kode berikut:

: << 'COMMENT'
This is a multiline block comment
using the single quote heredoc
and bash null command.
COMMENT
echo "Hello world!"
# This is a multiline comment
# using the single line notation.

Kode melakukan hal berikut:

• Baris 1 dan 5 adalah pembatas heredoc.
• Baris 2-4 adalah isi komentar blokir.
• Baris 6 adalah echo perintah.
• Baris 7-8 adalah beberapa komentar satu baris, yang bertindak sebagai komentar multibaris.

3. Simpan file dan tutup Vi:

:wq

4. Ubah izin skrip menjadi executable:

chmod +x multiline.sh

5. Terakhir, jalankan skrip untuk melihat output:

./multiline.sh

Keluaran terminal hanya menampilkan hasil di echo perintah, sementara baris yang dikomentari tidak ditampilkan.

Praktik Terbaik dan Kiat untuk Komentar Bash

Meskipun tidak ada aturan khusus untuk berkomentar di bash, praktik tertentu sangat membantu saat menggunakan komentar. Praktik dan kiat ini dimaksudkan untuk membantu Anda memaksimalkan komentar di bash.

1. Sertakan Header File

Semua skrip yang tidak terlihat pada pandangan pertama harus menyertakan header file. Header memiliki beberapa tujuan:

• Menjelaskan apa yang dilakukan kode secara sekilas.
• Menunjukkan kepengarangan.
• Menjelaskan pemberitahuan lisensi dan memberikan pernyataan izin untuk kode berhak cipta.

Gunakan komentar di awal kode untuk menjelaskan poin-poin ini. Selain itu, jika kode adalah bagian dari proyek, sertakan nama proyek.

2. Hindari Komentar Blokir yang Tidak Biasa

Meskipun komentar blokir dimungkinkan dalam skrip bash, itu adalah kebiasaan buruk untuk menggunakannya. Kode tidak mudah terlihat seperti komentar biasa karena editor teks tidak menjadikannya sebagai komentar. Selain itu, pencarian jauh lebih mudah bila ada sintaks komentar terpadu.

3. Hindari Komentar yang Panjang dan Tidak Perlu

Jauhkan komentar sesingkat mungkin dan to the point. Verbositas tidak diperlukan, dan itu membuat kode lebih sulit dibaca.

Demikian juga, hanya komentari kode yang sulit dipahami. Komentar tentang echo simple sederhana perintah tidak diperlukan, sedangkan kode yang menggunakan pernyataan regex kompleks memerlukan indikasi cepat tentang fungsinya.

4. Komentar dan Fungsi

Semua fungsi bash mendapat manfaat dari komentar yang menjelaskan tujuan, input yang diharapkan, dan output. Pengecualiannya adalah potongan kode pendek yang terlihat jelas.

Nyatakan berikut ini untuk setiap fungsi:

• Deskripsi singkat tentang operasi tersebut.
• Daftar variabel global atau variabel yang dimodifikasi.
• Argumen masukan yang diharapkan.
• Apa yang dihasilkan proses ke terminal.
• Nilai hasil yang diharapkan.

Di bawah ini adalah contoh fungsi yang mendokumentasikan setiap poin sebelumnya:

PREFIX="Hello "
#### FUNCTION BEGIN
# Prints a greeting
# GLOBALS: 
# 	PREFIX
# ARGUMENTS: 
# 	Name as a String to use for greeting
# OUTPUTS: 
# 	Writes String to STDOUT
# RETURN: 
# 	0 if success, non-zero otherwise.
### FUNCTION END
function () {
	echo "${PREFIX}: $1!"
}

Sesuaikan contoh dengan kasus penggunaan Anda.

5. Beri Label Secara Konsisten

Gunakan komentar untuk memberi label kode yang memerlukan perbaikan, implementasi, atau modifikasi. Buat label komentar yang konsisten untuk tugas yang berbeda agar lebih mudah menelusuri komentar.

Misalnya, awali dan akhiri setiap penjelasan fungsi dengan # FUNCTION BEGIN , atau tambahkan # TODO komentar untuk tugas masa depan. Demikian juga, putuskan label apa pun yang tampak cocok dan tetap konsisten di seluruh kode.