Mehrzeiliger Befehl mit Kommentaren nach dem Fortsetzungszeichen

Erwägen

echo \ # this is a comment
foo

Das gibt:

$ sh foo.sh
 # this is a comment
foo.sh: line 2: foo: command not found

Nach einigen Recherchen im Internet habe ich auf der Schwestersite Stack Overflow eine Lösung von DigitalRoss gefunden . Also kann man machen

echo `: this is a comment` \
foo

oder alternativ

echo $(: this is a comment) \
foo

DigitalRoss erklärte jedoch nicht, warum diese Lösungen funktionieren. Ich würde mich über eine Erklärung freuen. Er antwortete mit einem Kommentar:

Früher gab es einen Shell- gotoBefehl, der zu den :hier angegebenen Bezeichnungen verzweigte . Das gotoist weg, aber Sie können immer noch die : whateverSyntax verwenden ... :ist jetzt eine Art geparster Kommentar.

Aber ich hätte gerne mehr Details und Kontext, einschließlich einer Diskussion über Portabilität.

Wenn jemand andere Lösungen hat, wäre das natürlich auch gut.

Siehe auch die frühere Frage Wie kommentiere ich mehrzeilige Befehle in Shell-Skripten? .

Nachricht zum Mitnehmen aus der folgenden Diskussion. Dies `: this is a comment`ist nur eine Befehlsersetzung. Die Ausgabe von : this is a commentist nichts, und das wird an die Stelle von gesetzt `: this is a comment`.

Eine bessere Wahl ist die folgende:

echo `# this is a comment` \
foo

Kommentare enden in der ersten neuen Zeile (siehe Shell-Token-Erkennungsregel 10 ), ohne Fortsetzungszeilen zuzulassen. Daher befindet sich dieser Code fooin einer separaten Befehlszeile:

echo # this is a comment \
foo

Was Ihren ersten Vorschlag betrifft, folgt auf den umgekehrten Schrägstrich kein Zeilenumbruch, Sie zitieren lediglich das Leerzeichen: Es entspricht

echo ' # this is a comment'
foo

$(: this is a comment)ersetzt die Ausgabe des Befehls : this is a comment. Wenn die Ausgabe dieses Befehls leer ist, ist dies eine sehr verwirrende Möglichkeit, einen Kommentar in die Mitte einer Zeile einzufügen.

Es ist keine Magie im Gange: Es :ist ein gewöhnlicher Befehl, das Doppelpunkt- Dienstprogramm, das nichts tut. Das Doppelpunkt-Dienstprogramm ist vor allem dann nützlich, wenn für die Shell-Syntax ein Befehl erforderlich ist, Sie jedoch zufällig nichts zu tun haben.

# Sample code to compress files that don't look compressed
case "$1" in
  *.gz|*.tgz|*.bz2|*.zip|*.jar|*.od?) :;; # the file is already compressed
  *) bzip2 -9 "$1";;
esac

Ein weiterer Anwendungsfall ist eine Redewendung zum Festlegen einer Variablen, wenn diese noch nicht festgelegt ist.

: "${foo:=default value}"

Die Bemerkung über goto ist historisch. Das Colon-Dienstprogramm stammt noch aus der Zeit vor der Bourne-Shell bis zur Thompson-Shell , die eine goto- Anweisung enthielt . Der Doppelpunkt bedeutete dann eine Bezeichnung; Ein Doppelpunkt ist eine recht gebräuchliche Syntax für goto-Labels (sie ist in sed immer noch vorhanden ).

Sie können dies mit Bash-Arrays erreichen, z

#!/bin/bash
CMD=(
  echo  # this is a comment
  foo
  )

"${CMD[@]}"

Dies definiert ein Array $CMDund erweitert es dann. Nach dem Erweitern wird die resultierende Zeile ausgewertet und in diesem Fall echo fooausgeführt.

Der Text zwischen (und )definiert das Array und unterliegt der üblichen Bash-Syntax, sodass alle Zeilen danach #ignoriert werden.

Hinweis zum Beibehalten von Leerzeichen in Anführungszeichen

${CMD[@]}Wird zu einer einzelnen Zeichenfolge erweitert, die die Verkettung aller Elemente darstellt, die durch ein Leerzeichen getrennt sind. Einmal erweitert, parst Bash den String dann wie gewohnt in Token (vgl. $ IFS ), was oft nicht das ist, was wir wollen.

Im Gegensatz dazu bleibt "${CMD[@]}"jedes Element im Array erhalten, wenn die Erweiterung in doppelte Anführungszeichen eingeschlossen wird. Betrachten Sie den Unterschied zwischen hello world second itemund "hello world" "second item".

Bildhaftes Beispiel:

# LIST=("hello world" "second item")

# for ITEM in ${LIST[@]}; do echo $ITEM; done
hello
world
second
item

# for ITEM in "${LIST[@]}"; do echo $ITEM; done
hello world
second item

Sie nicht tun $(: comment). Das ist kein Kommentar - das ist eine Subshell - ein weiterer ganz neuer Shell-Prozess für die meisten Shells. Ihr Ziel ist es , weniger mit Ihrer Eingabe zu tun , nicht mehr, und das ist, was das tun würde - auch wenn es sinnlos ist.

Sie können stattdessen tun ...

printf '<%s>\n' some args here ${-##*"${--

                my long comment block

                }"}  and "more ${-##*"${--

                and another one in the
                middle of the quoted string
                there shouldn\'t b\e any special &
                (character) `echo issues here i hope >&2`
                basically anything that isn\'t a close \}
                $(echo the shell is looking for one >&2)
                }$(echo "}'"\" need backslash escaping >&2
                                )${-##*${--

                nesting is cool though

             }}"}here too"

}'" need backslash escaping
<some>
<args>
<here>
<and>
<more here too>

Grundsätzlich passiert dort, dass die Shell eine Substitution durchführt. Es ersetzt den Wert des speziellen Shell-Parameters $-jedes Mal zweimal. Es ist ohnehin eine kurze Zeichenfolge, aber sie ist immer gesetzt - und daher wird die innere Ersetzung, die als Muster interpretiert wird, das von der äußeren entfernt wird, nicht auf den Inhalt zwischen den Klammern ausgedehnt, wenn ich das -Erweiterungsformular verwende.

Hier:

bash -x <<""
printf %s\\n '${-##*"'${-- a set param doesn\'t expand to this optional text }'"}'

+ printf '%s\n' '${-##*"hxB"}'
${-##*"hxB"}

Sehen? Es ist also nur zweimal erweitert. Sobald die Shell feststellt, dass der Parameter gesetzt ist, wird fast alles im optionalen Erweiterungsfeld verworfen und es wird zu seinem gesamten Wert erweitert, der von sich selbst entfernt wird, und so zu gar nichts. In den meisten Shells müssen Sie nicht einmal Anführungszeichen entkommen, sondern es ist basherforderlich.

Besser noch ist:

COMMENT=
echo      ${COMMENT-"
           this will work the same way
           but the stripping isn\'t
           necessary because, while
           the variable is set, it is also
           empty, and so it will expand to
           its value - which is nothing
           "} this you\'ll see

this you'll see