Comment bloquez-vous les commentaires dans yaml?

Est-ce que quelqu’un sait comment commenter un bloc de lignes dans l’igname?

    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 numérique ( # ), peuvent commencer n’importe où sur une ligne et se poursuivre jusqu’à la fin de la ligne

    Une comparaison avec JSON, également depuis Wikipedia :

    Les différences de syntaxe sont subtiles et rarement rencontrées dans la pratique: JSON autorise des jeux de caractères étendus comme UTF-32, YAML requirejs un espace après les séparateurs tels que virgule, égal et deux-points inclure Javascript /* ... */ comments. Le traitement de ces cas de bord peut nécessiter un prétraitement léger du JSON avant d’être analysé en YAML en ligne.

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

    La spécification décrit uniquement 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 de bloc.

    Ne pas essayer d’être intelligent à ce sujet, mais si vous utilisez Sublime Text pour votre éditeur, les étapes sont les suivantes:

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

    J’imagine que d’autres éditeurs ont également des fonctionnalités similaires. Lequel utilisez-vous? Je serais ravi de faire des fouilles.

    Dans Vim, vous pouvez effectuer l’une des opérations suivantes:

    • Commenter toutes les lignes:: :%s/^/#
    • Lignes de commentaires 10 – 15 :10,15s/^/#
    • Ligne de commentaire 10 à la ligne actuelle :10,.s/^/#
    • Ligne de commentaire 10 pour terminer: :10,$s/^/#

    ou en utilisant un bloc visuel:

    1. Sélectionnez une colonne à plusieurs lignes après avoir saisi le bloc visuel via Ctrl + v .
    2. Appuyez sur r suivi de # pour mettre en commentaire le bloc à plusieurs lignes remplaçant la sélection ou sur Maj + i # Échap pour insérer des caractères de commentaire avant la sélection.

    Si vous utilisez Eclipse avec le plug-in yedit (un éditeur pour les fichiers .yaml), vous pouvez commenter plusieurs lignes en

    1. sélection des lignes à commenter, puis
    2. Ctrl + Maj + c

    et pour annuler le commentaire, suivez les mêmes étapes.

    Emacs a comment-dwim (Do What I Mean) – il suffit de sélectionner le bloc et de faire un:

    M-;

    C’est une bascule – utilisez-le pour commenter ET bloquer les commentaires.

    Si vous n’avez pas installé yaml-mode, vous devrez indiquer à Emacs d’utiliser le caractère de hachage (#).

    Pour les utilisateurs de Ruby Mine sous Windows:

    Ouvrir le fichier dans l’éditeur Sélectionnez le bloc et appuyez sur Ctrl + barre oblique , vous aurez sélectionné le bloc commençant par #.

    Maintenant, si vous souhaitez annuler le commentaire du bloc commenté, appuyez à nouveau sur la même combinaison de touches Ctrl + barre oblique

    Une approche alternative:

    Si

    • votre structure YAML a des champs bien définis à utiliser par votre application
    • ET vous pouvez librement append des champs supplémentaires qui ne gâchent pas votre application

    puis

    • à n’importe quel niveau, vous pouvez append un nouveau champ de texte de bloc nommé “Description” ou “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:

    1. Si les commentaires deviennent volumineux et complexes et présentent un motif répété, vous pouvez les promouvoir à partir de blocs de texte brut vers des objects.
    2. Votre application peut, à l’avenir, lire ou mettre à jour ces commentaires

    La seule façon de bloquer les commentaires dans YAML consiste à utiliser une autre application pour append une balise # (commentaire) à plusieurs lignes à la fois. Un exemple de ceci est l’option de clic droit “Bloquer le commentaire” pour le texte sélectionné dans Notepad ++.

    Woo Images!