Komentowanie zbioru wierszy w skrypcie powłoki

Najbardziej wszechstronną i bezpieczną metodą jest umieszczenie komentarza w pustce cytowanej here-document, tak:

<<"COMMENT"
    This long comment text includes ${parameter:=expansion}
    `command substitution` and $((arithmetic++ + --expansion)).
COMMENT

Przytaczając powyższy ogranicznik COMMENT jest konieczne, aby zapobiec parametrowi Rozszerzanie, zastępowanie poleceń i rozszerzanie arytmetyczne, które następowałoby w przeciwnym razie, jak podaje Instrukcja Bash , a standard powłoki POSIX określa .

W powyższym przypadku brak cytowania COMMENT spowodowałby powstanie zmiennej parameter przypisany tekst expansion, jeśli był pusty lub wyłączony, wykonanie polecenia command substitution, zmienna zwiększająca arithmetic i zmniejszająca zmienna expansion.

Porównując inne rozwiązania do tego:

Użycie if false; then comment text fi wymaga, aby tekst komentarza był poprawny składniowo Kod Bash, podczas gdy komentarze naturalne często nie są, jeśli tylko dla możliwych niezrównoważonych apostrofów. To samo dotyczy : || { comment text } konstruuj.

Umieszczanie komentarzy w pojedynczo cytowanym argumencie polecenia void, jak w :'comment text', ma wadę niemożności dołączania apostrofów. Double-quoted argumenty, jak w :"comment text", nadal podlegają rozszerzaniu parametrów, zastępowanie poleceń i rozszerzanie arytmetyczne, takie samo jak nie cytowane tutaj-treść dokumentu i może prowadzić do skutków ubocznych opisanych powyżej.

Używanie skryptów i narzędzi edytora do automatycznego prefiksu każdej linii w blok z ' # ' ma pewne zalety, ale nie odpowiada dokładnie na pytanie.

Możesz także dodawać komentarze Wielowierszowe używając:

: '
comment1comment1
comment2comment2
comment3comment3
comment4comment4
'

Zgodnie z referencją Bash dla Bourne Shell builtins

: (dwukropek)

: [argumenty]

Nie rób nic poza rozwijaniem argumentów i wykonywaniem przekierowań. Status powrotu wynosi zero.

Podziękowania dla Ikram za zwrócenie na to uwagi w poście skrypt powłoki umieścić komentarz wielu linii

Możesz użyć dokumentu "tutaj" bez polecenia, aby go wysłać.

#!/bin/bash
echo "Say Something"
<<COMMENT1
    your comment 1
    comment 2
    blah
COMMENT1
echo "Do something else"

Odnośnik Do Wikipedii

Edytory tekstu mają niesamowitą funkcję o nazwie Szukaj i zastępuj. Nie mówisz jakiego edytora używasz, ale ponieważ skrypty powłoki są zazwyczaj *nix, a ja używam VI, oto polecenie komentowania linii 20 do 50 jakiegoś skryptu powłoki:

:20,50s/^/#/

: || {
your code here
your code here
your code here
your code here
}

Co jeśli po prostu zawiń swój kod w funkcję?

Więc to:

cd ~/documents
mkdir test
echo "useless script" > about.txt

Staje się to:

CommentedOutBlock() {
  cd ~/documents
  mkdir test
  echo "useless script" > about.txt
}

W zależności od używanego edytora istnieje kilka skrótów do komentowania bloku wierszy.

Innym obejściem byłoby umieszczenie kodu w bloku warunkowym "if (0)";)

Zgodnie z tą stroną :

#!/bin/bash
foo=bar
: '
This is a test comment
Author foo bar
Released under GNU 
'

echo "Init..."
# rest of script

Ten jednowierszowy Perl komentuje linie od 1 do 3 pliku orig.sh inclusive (gdzie pierwsza linia ma numer 0) i zapisuje skomentowaną wersję do cmt.sh.

perl -n -e '$s=1;$e=3; $_="#$_" if $i>=$s&&$i<=$e;print;$i++' orig.sh > cmt.sh

Oczywiście możesz zmienić liczby graniczne zgodnie z wymaganiami.

Jeśli chcesz edytować plik w miejscu, jest jeszcze krótszy:

perl -in -e '$s=1;$e=3; $_="#$_" if $i>=$s&&$i<=$e;print;$i++' orig.sh

Demo

$ cat orig.sh 
a
b
c
d
e
f

$ perl -n -e '$s=1;$e=3; $_="#$_" if $i>=$s&&$i<=$e;print;$i++' orig.sh > cmt.sh

$ cat cmt.sh 
a
#b
#c
#d
e
f