Jak utworzyć wieloliniowe komentarze w Bash?

Niedawno zacząłem studiować skrypt powłoki i chciałbym móc komentować zestaw wierszy w skrypcie powłoki. Mam na myśli, że tak jest w przypadku C / Java:

/* comment1
   comment2 
   comment3
*/`

Jak mogłem to zrobić?

Użyj, : 'aby otworzyć i 'zamknąć.

Na przykład:

: '
This is a
very neat comment
in bash
'

Komentarz wieloliniowy w 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

Aktualizuję ten post na podstawie komentarzy i innych odpowiedzi, więc komentarze sprzed 22 maja 2020 roku mogą już nie mieć zastosowania.

Bash nie zapewnia wbudowanej składni komentarzy wieloliniowych, ale istnieją hacki wykorzystujące istniejącą składnię bash, która „działa teraz”.

Osobiście uważam, że najprostszym (tj. Najmniej hałaśliwym, najmniej dziwnym, najłatwiejszym do pisania, najbardziej wyraźnym) jest użycie cytowanego HEREDOC, ale wyraź to, co robisz, i używaj tego samego markera HEREDOC wszędzie:

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

line 3
line 4
### BLOCK COMMENT

Pojedynczy cytat znacznika HEREDOC pozwala uniknąć niektórych skutków ubocznych analizy powłoki, takich jak dziwne zmiany, które spowodowałyby awarię lub wynik, a nawet analizę samego markera. Tak więc pojedyncze cudzysłowy dają więcej swobody na znaczniku komentarza „otwórz i zamknij”. Na przykład poniżej używa potrójnego skrótu, który sugeruje wieloliniowy komentarz w bash. Spowodowałoby to awarię skryptu, gdyby pojedyncze cytaty były nieobecne. Nawet jeśli usuniesz ###, FOO{}spowoduje to awarię skryptu (lub spowoduje wydrukowanie złej substytucji, jeśli nie set -e), gdyby nie pojedyncze cytaty:

set -e

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

ls

Oczywiście możesz po prostu użyć

set -e

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

ls

ale cel tego jest zdecydowanie mniej jasny dla czytelnika niezaznajomionego z tą sztuczką.

Obecnie każdy dobry edytor pozwala nacisnąć Ctrl- / lub podobny, aby anulować / skomentować wybór. Wszyscy na pewno to rozumieją:

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

chociaż wprawdzie nie jest to tak wygodne jak powyższy komentarz blokowy, jeśli chcesz ponownie wypełnić akapity.

Z pewnością istnieją inne techniki, ale wydaje się, że nie ma „konwencjonalnego” sposobu na zrobienie tego. Byłoby miło, gdyby ###>i ###<mógł zostać dodany do bash, aby wskazać początek i koniec bloku komentarza, wydaje się, że może być całkiem prosty.

Po przeczytaniu innych odpowiedzi tutaj wymyśliłem poniżej, co według IMHO jest naprawdę jasne, że to komentarz. Szczególnie nadaje się do informacji o użyciu w skrypcie:

<< ////

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.

////

Jako programista sekwencja ukośników natychmiast rejestruje się w moim mózgu jako komentarz (nawet jeśli ukośniki są zwykle używane w komentarzach liniowych).

Oczywiście "////"to tylko struna; liczba ukośników w prefiksie i sufiksie musi być równa.

jakie jest twoje zdanie na ten temat?

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
  }
}

Oto jak robię komentarze wieloliniowe w bash.

Ten mechanizm ma dwie zalety, które doceniam. Jednym z nich jest to, że komentarze można zagnieżdżać. Drugim jest to, że bloki można włączyć, po prostu komentując linię inicjującą.

#!/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

W powyższym przykładzie blok „B” jest komentowany, ale części bloku „A”, które nie są blokiem „B”, nie są komentowane.

Uruchomienie tego przykładu spowoduje wygenerowanie tego wyniku:

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

Wypróbowałem wybraną odpowiedź, ale okazało się, że kiedy uruchomiłem skrypt powłoki, wszystko było drukowane na ekranie (podobnie jak w notatnikach jupyter drukuje wszystko w '''xx'''cudzysłowie) i na końcu pojawił się komunikat o błędzie. Nie robił nic, ale: przerażający . Podczas edycji zdałem sobie sprawę, że pojedyncze cudzysłowy mogą obejmować wiele wierszy. Więc .. po prostu przypiszmy blok do zmiennej.

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

ls -l
date

'

Proste rozwiązanie, mało inteligentne:

Tymczasowo zablokuj część skryptu:

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

Trochę wyrafinowana wersja:

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

# Lubię lenistwo i prostotę. Użyłbym # ze śmiesznym obejściem:

1 NACIŚNIJ:] znajdź ctrl + F lub cmd + F lub cokolwiek [, aby uruchomić funkcję wyszukiwania

2 użyj wyrażenia regularnego w polu wyszukiwania, np .: (^.+)

3 zamień na: # $1lub jeśli wolisz#$1

# Uwaga: możesz nie mieć trzech kroków w swoim edytorze. W takim przypadku skorzystaj z internetowego narzędzia do wyrażania regularnego (nie możesz zasugerować go tutaj ze względów politycznych):

1. Wybierz, skopiuj tekst gdziekolwiek jesteś i wklej go w internetowym narzędziu regex
2. Użyj (^.+)jako wyrażeń regularnych i / #$1lub #\1jako wzorców podstawienia
3. Wybierz, skopiuj tekst i wklej go z powrotem w miejscu rozpoczęcia

# Baw się dobrze!