YAML - Kommentare

Nachdem Sie mit der Syntax und den Grundlagen von YAML vertraut sind, gehen wir weiter auf die Details ein. In diesem Kapitel erfahren Sie, wie Sie Kommentare in YAML verwenden.

YAML supports single line comments. Seine Struktur wird unten anhand eines Beispiels erläutert -

# this is single line comment.

YAML does not support multi line comments. Wenn Sie Kommentare für mehrere Zeilen bereitstellen möchten, können Sie dies wie im folgenden Beispiel gezeigt tun -

# this
# is a multiple
# line comment

Funktionen von Kommentaren

Die Funktionen von Kommentaren in YAML sind unten angegeben -

Ein kommentierter Block wird während der Ausführung übersprungen.
Kommentare helfen beim Hinzufügen einer Beschreibung für den angegebenen Codeblock.
Kommentare dürfen nicht in Skalaren erscheinen.
YAML enthält keine Möglichkeit, das Hash-Symbol (#) innerhalb einer mehrzeiligen Zeichenfolge zu umgehen, sodass der Kommentar nicht vom Wert der Rohzeichenfolge getrennt werden kann.

Die Kommentare innerhalb einer Sammlung werden unten angezeigt -

key: #comment 1
   - value line 1
   #comment 2
   - value line 2
   #comment 3
   - value line 3

Die Tastenkombination zum Kommentieren von YAML-Blöcken lautet Ctrl+Q.

Wenn Sie verwenden Sublime Text editorDie Schritte zum Kommentieren des Blocks sind unten aufgeführt -

Wählen Sie den Block aus. Verwenden Sie "STRG + /" unter Linux und Windows und "CMD + /" für Mac-Betriebssysteme. Führen Sie den Block aus.

Beachten Sie, dass die gleichen Schritte gelten, wenn Sie verwenden Visual Studio Code Editor. Es wird immer empfohlen, zu verwendenSublime Text Editor zum Erstellen von YAML-Dateien, wie sie von den meisten Betriebssystemen unterstützt werden und entwicklerfreundliche Tastenkombinationen enthalten.