YAML prend en charge les commentaires en ligne, mais pas les commentaires de blocage.
De Wikipedia :
Les commentaires commencent par le signe numérique (
#), peuvent commencer n'importe où sur une ligne et se poursuivre jusqu'à la fin de la ligne.
Une comparaison avec JSON, également de Wikipedia :
Les différences de syntaxe sont subtiles et se produisent rarement dans la pratique: JSON autorise des jeux de caractères étendus comme UTF-32, YAML nécessite un espace après les séparateurs tels que virgule, égal et deux points, contrairement à JSON, et certaines implémentations non standard de JSON étendent la grammaire à inclure les commentaires
/* ... */de Javascript. La gestion de tels cas Edge peut nécessiter un pré-traitement léger du JSON avant une analyse en tant que YAML en ligne.
# If you want to write
# a block-commented Haiku
# you'll need three pound signs
Le spec décrit uniquement un moyen de marquer les commentaires:
Un commentaire explicite est marqué d'un "#".
C'est tout. Il n'y a pas de commentaires de bloc.
N'essayez pas d'être intelligent à ce sujet, mais si vous utilisez Sublime Text pour votre éditeur, les étapes sont les suivantes:
- Sélectionnez le bloc
- cmd+/ sur Mac ou ctrl+/ sous Linux et Windows
- Profit
J'imagine que d'autres éditeurs ont aussi des fonctionnalités similaires. Lequel utilisez-vous? Je serais heureux de faire des recherches.
Dans Vim, vous pouvez effectuer l’une des opérations suivantes:
- Commenter toutes les lignes:
:%s/^/# - Commentaires lignes 10 à 15:
:10,15s/^/# - Commentaire de la ligne 10 à la ligne actuelle:
:10,.s/^/# - Commentaire de la ligne 10 à la fin:
:10,$s/^/#
ou en utilisant un bloc visuel:
- Sélectionnez une colonne de plusieurs lignes après avoir entré le bloc visuel via Ctrl+v.
- Presse r suivi par # mettre en commentaire le bloc multiligne remplaçant la sélection, ou Shift+i#Esc insérer des caractères de commentaire avant la sélection.
ne approche alternative:
Si
- votre structure YAML a des champs bien définis à utiliser par votre application
- ET vous pouvez librement ajouter des champs supplémentaires qui ne vont pas gâcher votre application
ensuite
- à tout niveau, vous pouvez ajouter un nouveau champ de texte de bloc nommé "Description", "Commentaire" ou "Notes" ou autre
Exemple:
Au lieu de
# This comment
# is too long
utilisation
Description: >
This comment
is too long
ou
Comment: >
This comment is also too long
and newlines survive from parsing!
Plus d'avantages:
- Si les commentaires deviennent volumineux et complexes et comportent un motif répétitif, vous pouvez les promouvoir, des blocs de texte brut aux objets.
- Votre application peut éventuellement lire ou mettre à jour ces commentaires.
Si vous utilisez Eclipse avec le plugin yedit (un éditeur pour les fichiers .yaml), vous pouvez commenter plusieurs lignes en:
- sélectionner les lignes à commenter, puis
- Ctrl + Shift + C
Et pour annuler le commentaire, suivez les mêmes étapes.
Emacs a comment-dwim (fais ce que je veux dire) - il suffit de sélectionner le bloc et de faire un:
M-;
C'est une bascule - utilisez-la pour commenter ET décommenter les blocs.
Si vous n'avez pas installé yaml-mode, vous devrez dire à Emacs d'utiliser le caractère de hachage (#).
Pour Ruby Mine utilisateurs sous Windows:
Ouvrir le fichier dans l'éditeur Sélectionnez le bloc et appuyez sur Ctrl+forward slash, vous aurez sélectionné le bloc commençant par #.
Maintenant, si vous voulez supprimer le commentaire du bloc commenté, appuyez sur la même combinaison de touches Ctrl+forward slash encore
Pour les utilisateurs de Visual Studio Code (VSCode), le raccourci pour commenter plusieurs lignes consiste à mettre en surbrillance les lignes que vous souhaitez commenter, puis à appuyer sur:
ctrl + /
Pressage ctrl + / à nouveau peut également être utilisé pour désactiver les commentaires pour une ou plusieurs lignes sélectionnées.
Une façon de bloquer les commentaires dans YAML consiste à utiliser un éditeur de texte tel que Notepad ++ pour ajouter une balise # (comment) à plusieurs lignes à la fois.
Dans Notepad ++, vous pouvez utiliser l’option de clic droit "Bloquer les commentaires" pour le texte sélectionné.
