it-swarm.com.de

Wie blockiert man Kommentare in YAML?

Wie kommentiere ich einen Zeilenblock in YAML?

1226
Thierry Lam

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

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, auch aus Wikipedia :

Die Syntaxunterschiede sind subtil und treten in der Praxis selten auf: JSON ermöglicht erweiterte Zeichensätze wie UTF-32, YAML erfordert ein Leerzeichen nach Trennzeichen wie Komma, Gleichheit und Doppelpunkt, während JSON dies nicht tut, und einige nicht standardmäßige Implementierungen von JSON erweitern die Grammatik auf füge Javascript's /* ... */ Kommentare hinzu. Die Behandlung solcher Edge-Fä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
1827
Dolph

Das spec beschreibt nur eine Möglichkeit, Kommentare zu markieren:

Ein expliziter Kommentar ist mit einem "#" gekennzeichnet.

Das ist alles. Es gibt keine Blockkommentare.

194
Eugene Yarmash

Versuchen Sie nicht, klug zu sein, aber wenn Sie Sublime Text für Ihren Editor verwenden, gehen Sie wie folgt vor:

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

Ich könnte mir vorstellen, dass auch andere Editoren ähnliche Funktionen haben. Welches verwenden Sie? Ich würde gerne etwas graben.

122
Kyle Carlson

In Vim können Sie eine der folgenden Aktionen ausführen:

  • Kommentiere alle Zeilen: :%s/^/#
  • Kommentarzeilen 10 - 15: :10,15s/^/#
  • Kommentarzeile 10 zur aktuellen Zeile: :10,.s/^/#
  • Kommentarzeile 10 zum Ende: :10,$s/^/#

oder mit visuellen Block:

  1. Wählen Sie eine mehrzeilige Spalte aus, nachdem Sie den Sichtblock über eingegeben haben Ctrl+v.
  2. Drücken Sie r gefolgt von # den mehrzeiligen Block auskommentieren, der die Auswahl ersetzt, oder Shift+i#Esc Kommentarzeichen vor der Auswahl einfügen.
64
knownasilya

Ein alternativer Ansatz:

Wenn

  • ihre YAML-Struktur enthält gut definierte Felder, die von Ihrer App verwendet werden können
  • UND Sie können weitere Felder hinzufügen, die Ihre App nicht beeinträchtigen

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 von

# 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 hochstufen
  2. Ihre App kann diese Kommentare in Zukunft lesen oder aktualisieren
18

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 klicken Sie dann auf OK
  2. Ctrl + Shift + C

Befolgen Sie zum Entkommentieren die gleichen Schritte.

6

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

M-;

Es ist ein Toggle - benutze es, 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.

5
Lester Cheung

Für Ruby Meine Benutzer unter Windows:

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

Wenn Sie den kommentierten Block jetzt auskommentieren möchten, drücken Sie dieselbe Tastenkombination Ctrl+forward slash nochmal

4
paul

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

ctrl + /

Drücken Sie ctrl + / Auch hier können Sie Kommentare für eine oder mehrere ausgewählte Zeilen deaktivieren.

3
Mark Wragg

Eine Möglichkeit, das Kommentieren in YAML zu blockieren, ist die Verwendung eines Texteditors wie Notepad ++, um mehrere Zeilen gleichzeitig mit einem # -Tag (Kommentar) zu versehen.

In Notepad ++ können Sie dies tun, indem Sie mit der rechten Maustaste auf die Option "Kommentar blockieren" für ausgewählten Text klicken.

Woo Images!

2
Nathan Meyer