Wie blockiert man Kommentare in YAML?

Wie kommentiere ich einen Zeilenblock in YAML?

YAML unterstützt Inline-Kommentare, jedoch keine Blockkommentare.

Aus Wikipedia :

Kommentare beginnen mit dem Nummernzeichen ( #), können an einer beliebigen Stelle in einer Zeile beginnen und bis zum Ende der Zeile fortgesetzt werden

Ein Vergleich mit JSON, ebenfalls aus Wikipedia :

Die Syntaxunterschiede sind subtil und treten in der Praxis selten auf: JSON erlaubt erweiterte Zeichensätze wie UTF-32, YAML benötigt ein Leerzeichen nach Trennzeichen wie Komma, Gleich und Doppelpunkt, während JSON dies nicht tut, und einige nicht standardmäßige Implementierungen von JSON erweitern die Grammatik auf Fügen Sie die /* ... */Kommentare von Javascript hinzu . Die Behandlung solcher Randfälle erfordert möglicherweise eine leichte Vorverarbeitung des JSON, bevor es als Inline-YAML analysiert wird.

# If you want to write
# a block-commented Haiku
# you'll need three pound signs

Die Spezifikation beschreibt nur eine Möglichkeit, Kommentare zu markieren:

Ein expliziter Kommentar ist durch ein "#" gekennzeichnet.

Das ist alles. Es gibt keine Blockkommentare.

Versuchen Sie nicht, klug zu sein, aber wenn Sie Sublime Text für Ihren Editor verwenden, sind die Schritte:

1. Wählen Sie den Block aus
2. cmd+ /auf Mac oder ctrl+ /unter Linux & Windows
3. Profitieren

Ich würde mir vorstellen, dass auch andere Editoren ähnliche Funktionen haben. Welches benutzt du? Ich würde gerne etwas graben.

In Vim können Sie einen der folgenden Schritte ausführen:

• Alle Zeilen kommentieren: :%s/^/#
• Kommentarzeilen 10 - 15: :10,15s/^/#
• Kommentar Zeile 10 zur aktuellen Zeile: :10,.s/^/#
• Kommentarzeile 10 bis Ende: :10,$s/^/#

oder mit visuellem Block:

1. Wählen Sie nach Eingabe des visuellen Blocks über eine mehrzeilige Spalte aus Ctrl+v.
2. Drücken Sie ranschließend #, um den mehrzeiligen Block zu kommentieren, der die Auswahl ersetzt, oder Shift+i#Escum Kommentarzeichen vor der Auswahl einzufügen.

Ein alternativer Ansatz:

Wenn

• Ihre YAML-Struktur verfügt über genau definierte Felder, die von Ihrer App verwendet werden können
• UND Sie können frei zusätzliche Felder hinzufügen, die Ihre App nicht durcheinander bringen

dann

• Auf jeder Ebene können Sie ein neues Blocktextfeld mit dem Namen "Beschreibung" oder "Kommentar" oder "Notizen" oder was auch immer hinzufügen

Beispiel:

Anstatt

# This comment
# is too long

verwenden

Description: >
  This comment
  is too long

oder

Comment: >
    This comment is also too long
    and newlines survive from parsing!

Weitere Vorteile:

1. Wenn die Kommentare groß und komplex werden und ein sich wiederholendes Muster aufweisen, können Sie sie von einfachen Textblöcken zu Objekten heraufstufen
2. Ihre App kann diese Kommentare in Zukunft lesen oder aktualisieren

Eine Möglichkeit, das Kommentieren in YAML zu blockieren, besteht darin, mit einem Texteditor wie Notepad ++ mehreren Zeilen gleichzeitig ein # (Kommentar) -Tag hinzuzufügen.

In Notepad ++ können Sie dies mit der Rechtsklickoption "Kommentar blockieren" für ausgewählten Text tun.

Wenn Sie Eclipse mit dem yedit-Plugin (einem Editor für .yaml-Dateien) verwenden, können Sie mehrere Zeilen auskommentieren, indem Sie:

1. Wählen Sie die zu kommentierenden Zeilen aus und dann
2. Ctrl+ Shift+C

Befolgen Sie zum Aufheben des Kommentars die gleichen Schritte.

Für Ruby Mine-Benutzer unter Windows:

Datei im Editor öffnen Wählen Sie den Block aus und drücken Sie Ctrl+ forward slash. Sie haben den Block beginnend mit # ausgewählt.

Wenn Sie nun den kommentierten Block auskommentieren möchten, drücken Sie dieselbe Tastenkombination Ctrl+ forward slasherneut

Emacs hat comment-dwim (Mach was ich meine) - wähle einfach den Block aus und mache ein:

M-;

Es ist ein Umschalter - verwenden Sie ihn, um Blöcke zu kommentieren UND zu kommentieren.

Wenn Sie den Yaml-Modus nicht installiert haben, müssen Sie Emacs anweisen, das Hash-Zeichen (#) zu verwenden.

Für Benutzer von Visual Studio Code (VSCode) besteht die Verknüpfung zum Auskommentieren mehrerer Zeilen darin, die zu kommentierenden Zeilen hervorzuheben und dann zu drücken:

ctrl + /

Durch erneutes Drücken von ctrl+ /können Sie auch Kommentare für eine oder mehrere ausgewählte Zeilen deaktivieren.

Im Azure Devops-Browser (Pipeline-Yaml-Editor)

Ctrl+ K+ CKommentarblock

Ctrl+ K+ UKommentarblock

Es gibt auch die Option "Blockkommentar umschalten", aber das hat bei mir nicht funktioniert.

Es gibt auch andere "seltsame" Möglichkeiten: Klicken Sie mit der rechten Maustaste, um "Befehlspalette" oder "Befehlspalette" anzuzeigen F1

Wählen Sie dann eine Cursoroption.

Jetzt ist es nur noch eine Frage von #

oder noch schlauer [ Ctrl+ k] + [ Ctrl+ c]