Frage Wie blockierst du Kommentare in Yaml?


Kann jemand einen Block von Zeilen in Yaml kommentieren?


953
2018-02-16 21:42


Ursprung


Antworten:


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

Von Wikipedia:

Kommentare beginnen mit dem Nummernzeichen ( # ), kann überall in einer Zeile beginnen und bis zum Ende der Zeile fortfahren

Ein Vergleich mit JSON, auch von Wikipedia:

Die Syntaxunterschiede sind subtil und treten selten in der Praxis auf: JSON erlaubt erweiterte Zeichensätze wie UTF-32, YAML erfordert einen Abstand nach Trennzeichen wie Komma, Gleichheit und Doppelpunkt, während JSON dies nicht tut, und einige nicht standardisierte Implementierungen von JSON erweitern die Grammatik include Javascript /* ... */ Bemerkungen. Die Behandlung solcher Kantenfälle erfordert möglicherweise eine leichte Vorverarbeitung des JSON vor dem Parsing als Inline-YAML.

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

1455
2018-02-16 21:47



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

Ein expliziter Kommentar ist mit einem "#" gekennzeichnet.

Das ist alles. Es gibt keine Blockkommentare.


146
2018-02-16 21:52



Ich versuche nicht, schlau zu sein, aber wenn Sie Sublime Text für Ihren Editor verwenden, lauten die Schritte:

  1. Wählen Sie den Block aus
  2. CMD + / auf Mac oder CTRL + / unter Linux und Windows
  3. Profitieren

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


82
2018-05-22 18:20



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

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

oder mit einem visuellen Block:

  1. Wählen Sie eine mehrzeilige Spalte nach Eingabe des visuellen Blocks über Strg + v.
  2. Drücken Sie r gefolgt von # Auskommentieren des Mehrfachlinienblocks, der die Auswahl ersetzt, oder Umschalt + i#Esc um Kommentarzeichen vor der Auswahl einzufügen.

48
2017-07-09 19:25



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

  1. Zeilen auswählen, die kommentiert werden sollen, und dann
  2. Strg + Umschalt + c

und um Kommentare zu entfernen, folgen Sie den gleichen Schritten.


7
2017-07-05 13:42



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

M-;

Es ist ein Toggle - verwenden Sie es, um Blöcke kommentieren und auskommentieren.

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


5
2017-11-20 00:17



Für Ruby-Mine-Benutzer unter Windows:

Datei im Editor öffnen Wählen Sie den Block und drücken Sie Strg+Schrägstrich, Sie haben einen Block ausgewählt, der mit # beginnt.

Wenn Sie nun den kommentierten Block deaktivieren möchten, drücken Sie die gleiche Tastenkombination Strg+Schrägstrich nochmal


4
2017-12-25 18:13



Ein alternativer Ansatz:

Ob

  • 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 nicht mit Ihrer App verwechselt werden

dann

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

Beispiel:

Anstatt von

# This comment
# is too long

benutzen

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 könnte diese Kommentare in Zukunft lesen oder aktualisieren

3
2018-04-26 07:45



Die einzige Möglichkeit, Kommentare in YAML zu blockieren, besteht darin, mit einer anderen Anwendung ein # (Kommentar) -Tag gleichzeitig mehreren Zeilen hinzuzufügen. Ein Beispiel dafür ist die Option "Blockkommentar" mit der rechten Maustaste für ausgewählten Text in Notepad ++.

Woo Images!


2
2018-05-04 00:10