Comment faites-vous des commentaires de bloc en YAML?

Question

Comment puis-je commenter un bloc de lignes en YAML ?

Answer 1

YAML prend en charge les commentaires en ligne, mais ne prend pas en charge les commentaires de bloc.

De Wikipedia:

Les commentaires commencent par le signe dièse ( # ), peuvent commencer n'importe où sur une ligne, et se poursuivent jusqu'à la fin de la ligne

Une comparaison avec JSON, également de Wikipedia:

Les différences de syntaxe sont subtiles et surviennent rarement en pratique : JSON permet des jeux de caractères étendus comme UTF-32, YAML nécessite un espace après les séparateurs tels que la virgule, le signe égal et le deux-points alors que JSON ne le fait pas, et certaines implémentations non standard de JSON étendent la grammaire pour inclure les commentaires de Javascript /* ... */. Traiter de tels cas particuliers peut nécessiter un prétraitement léger du JSON avant l'analyse en tant que YAML en ligne.

# Si vous voulez écrire
# un Haïku commenté en bloc
# vous aurez besoin de trois dièses

Answer 2

La spécification décrit seulement une façon de marquer les commentaires :

Un commentaire explicite est marqué par un indicateur “#”.

C'est tout. Il n'y a pas de commentaires en bloc.

Answer 3

Je n'essaie pas d'être intelligent à ce sujet, mais si vous utilisez Sublime Text pour votre éditeur, les étapes sont :

1. Sélectionnez le bloc
2. Cmd + / sur Mac ou Ctrl + / sur Linux et Windows
3. Profit

Je suppose que d'autres éditeurs ont des fonctionnalités similaires aussi. Lequel utilisez-vous? Je serais heureux de faire quelques recherches.

Answer 4

Dans Vim, vous pouvez faire l'une des actions suivantes:

• Commenter toutes les lignes: :%s/^/#
• Commenter les lignes 10 à 15: :10,15s/^/#
• Commenter de la ligne 10 à la ligne actuelle: :10,.s/^/#
• Commenter de la ligne 10 jusqu'à la fin: :10,$s/^/#

ou en utilisant le bloc visuel :

1. Sélectionnez une colonne sur plusieurs lignes après avoir entré en mode bloc visuel via Ctrl+v.
2. Appuyez sur r suivi de # pour commenter le bloc sur plusieurs lignes en remplaçant la sélection, ou Shift+i#Esc pour insérer des caractères de commentaire avant la sélection.

Answer 5

Une approche alternative:

Si

• votre structure YAML a des champs bien définis à utiliser par votre application
• ET que vous pouvez librement ajouter des champs supplémentaires qui ne perturberont pas votre application

alors

• à n'importe quel niveau, vous pouvez ajouter un nouveau champ de texte en bloc nommé "Description" ou "Commentaire" ou "Notes" ou autre

Exemple:

Au lieu de

# Ce commentaire
# est trop long

utilisez

Description: >
  Ce commentaire
  est trop long

ou

Commentaire: >
    Ce commentaire est également trop long
    et les sauts de ligne sont conservés lors de l'analyse!

Plus d'avantages:

1. Si les commentaires deviennent grands et complexes et ont un modèle récurrent, vous pouvez les promouvoir de simples blocs de texte à des objets
2. Votre application pourra -à l'avenir- lire ou mettre à jour ces commentaires