Cara membuat komentar multiline di Bash?

Saya baru-baru ini mulai mempelajari skrip shell dan saya ingin dapat mengomentari serangkaian baris dalam skrip shell. Maksud saya seperti dalam kasus C / Java:

/* comment1
   comment2 
   comment3
*/`

Bagaimana saya bisa melakukan itu?

Gunakan : 'untuk membuka dan 'menutup.

Sebagai contoh:

: '
This is a
very neat comment
in bash
'

Komentar multiline dalam bash

: <<'END_COMMENT'
This is a heredoc (<<) redirected to a NOP command (:).
The single quotes around END_COMMENT are important,
because it disables variable resolving and command resolving
within these lines.  Without the single-quotes around END_COMMENT,
the following two $() `` commands would get executed:
$(gibberish command)
`rm -fr mydir`
comment1
comment2 
comment3
END_COMMENT

Saya memperbarui posting ini berdasarkan komentar dan jawaban lain, jadi komentar sebelum 22 Mei 2020 mungkin tidak berlaku lagi.

Bash tidak menyediakan sintaks bawaan untuk komentar multi-baris tetapi ada hack menggunakan sintaks bash yang ada yang "kebetulan bekerja sekarang".

Secara pribadi saya pikir yang paling sederhana (yaitu paling tidak berisik, paling aneh, paling mudah untuk mengetik, paling eksplisit) adalah dengan menggunakan HEREDOC yang dikutip, tetapi jelaskan apa yang Anda lakukan, dan gunakan penanda HEREDOC yang sama di mana-mana:

<<'### BLOCK COMMENT'
line 1
line 2

line 3
line 4
### BLOCK COMMENT

Mengutip penanda HEREDOC tunggal menghindari beberapa efek samping penguraian shell, seperti penggantian yang aneh yang akan menyebabkan kerusakan atau keluaran, dan bahkan penguraian penanda itu sendiri. Jadi tanda kutip tunggal memberi Anda lebih banyak kebebasan pada penanda komentar buka-tutup. Sebagai contoh, berikut ini menggunakan hash tiga jenis saran multi-line di bash. Ini akan merusak skrip jika tanda kutip tunggal tidak ada. Bahkan jika Anda menghapus ###, FOO{}skrip tersebut akan macet (atau menyebabkan substitusi buruk dicetak jika tidak set -e) jika bukan karena tanda kutip tunggal:

set -e

<<'### BLOCK COMMENT'
something something ${FOO{}} something
more comment
### BLOCK COMMENT

ls

Anda tentu saja bisa menggunakan

set -e

<<'###'
something something ${FOO{}} something
more comment
###

ls

tetapi niat ini jelas kurang jelas bagi pembaca yang tidak terbiasa dengan tipuan ini.

Saat ini setiap editor yang baik memungkinkan Anda untuk menekan ctrl- / atau yang serupa, untuk membatalkan komentar. Semua orang pasti mengerti ini:

# something something ${FOO{}} something
# more comment
# yet another line of comment

walaupun harus diakui, ini hampir tidak nyaman seperti komentar blok di atas jika Anda ingin mengisi ulang paragraf Anda.

Pasti ada teknik lain, tetapi sepertinya tidak ada cara "konvensional" untuk melakukannya. Akan lebih baik jika ###>dan ###<dapat ditambahkan ke bash untuk menunjukkan awal dan akhir dari blok komentar, sepertinya itu bisa sangat mudah.

Setelah membaca jawaban lain di sini saya datang dengan di bawah ini, yang IMHO membuatnya sangat jelas itu adalah komentar. Sangat cocok untuk info penggunaan dalam skrip:

<< ////

Usage:
This script launches a spaceship to the moon. It's doing so by 
leveraging the power of the Fifth Element, AKA Leeloo.
Will only work if you're Bruce Willis or a relative of Milla Jovovich.

////

Sebagai seorang programmer, urutan garis miring segera mendaftar di otak saya sebagai komentar (meskipun garis miring biasanya digunakan untuk komentar garis).

Tentu saja, "////"hanya string; jumlah garis miring pada awalan dan akhiran harus sama.

apa pendapatmu tentang ini?

function giveitauniquename()
{
  so this is a comment
  echo "there's no need to further escape apostrophes/etc if you are commenting your code this way"
  the drawback is it will be stored in memory as a function as long as your script runs unless you explicitly unset it
  only valid-ish bash allowed inside for instance these would not work without the "pound" signs:
  1, for #((
  2, this #wouldn't work either
  function giveitadifferentuniquename()
  {
    echo nestable
  }
}

Inilah cara saya melakukan komentar multiline di bash.

Mekanisme ini memiliki dua keunggulan yang saya hargai. Salah satunya adalah bahwa komentar dapat disarangkan. Yang lain adalah bahwa blok dapat diaktifkan hanya dengan mengomentari garis awal.

#!/bin/bash
# : <<'####.block.A'
echo "foo {" 1>&2
fn data1
echo "foo }" 1>&2
: <<'####.block.B'
fn data2 || exit
exit 1
####.block.B
echo "can't happen" 1>&2
####.block.A

Dalam contoh di atas, blok "B" dikomentari, tetapi bagian-bagian dari blok "A" yang bukan blok "B" tidak dikomentari.

Menjalankan contoh itu akan menghasilkan output ini:

foo {
./example: line 5: fn: command not found
foo }
can't happen

Saya mencoba jawaban yang dipilih, tetapi menemukan ketika saya menjalankan skrip shell memilikinya, semuanya dicetak ke layar (mirip dengan bagaimana notebook jupyter mencetak semuanya dalam '''xx'''tanda kutip) dan ada pesan kesalahan pada akhirnya. Itu tidak melakukan apa-apa, tetapi: menakutkan . Kemudian saya menyadari ketika mengeditnya bahwa tanda kutip tunggal dapat menjangkau beberapa baris. Jadi .. mari kita tetapkan saja blok ke variabel.

x='
echo "these lines will all become comments."
echo "just make sure you don_t use single-quotes!"

ls -l
date

'

Solusi sederhana, tidak terlalu pintar:

Memblokir sementara bagian skrip:

if false; then
    while you respect syntax a bit, please
    do write here (almost) whatever you want.
    but when you are
    done # write
fi

Versi yang agak canggih:

time_of_debug=false # Let's set this variable at the beginning of a script

if $time_of_debug; then # in a middle of the script  
    echo I keep this code aside until there is the time of debug!
fi

# Saya suka kemalasan dan kesederhanaan. Saya akan menggunakan # dengan solusi lucu:

1 PRESS:] temukan ctrl + F atau cmd + F atau apa pun [untuk memicu fungsi temukan

2 gunakan regex di bidang temukan seperti: (^.+)

3 ganti dengan: # $1atau jika Anda suka#$1

# Catatan: Anda mungkin tidak memiliki tiga langkah di editor Anda. Dalam hal itu gunakan alat regex online (tidak dapat menyarankan satu di sini karena alasan kebijakan):

1. Pilih, salin teks di manapun Anda berada dan tempel di alat regex online
2. Gunakan (^.+)sebagai regex dan #$1atau #\1sebagai pola substitusi
3. Pilih, salin teks dan tempel kembali ke tempat Anda memulai

# Nikmati hash Anda!