YAML - Commentaires

Maintenant que vous êtes à l'aise avec la syntaxe et les bases de YAML, passons plus loin dans ses détails. Dans ce chapitre, nous verrons comment utiliser les commentaires en YAML.

YAML supports single line comments. Sa structure est expliquée ci-dessous à l'aide d'un exemple -

# this is single line comment.

YAML does not support multi line comments. Si vous souhaitez fournir des commentaires pour plusieurs lignes, vous pouvez le faire comme indiqué dans l'exemple ci-dessous -

# this
# is a multiple
# line comment

Caractéristiques des commentaires

Les caractéristiques des commentaires dans YAML sont données ci-dessous -

• Un bloc commenté est ignoré lors de l'exécution.

• Les commentaires aident à ajouter une description pour le bloc de code spécifié.

• Les commentaires ne doivent pas apparaître à l'intérieur des scalaires.

• YAML n'inclut aucun moyen d'échapper au symbole de hachage (#), donc dans une chaîne multiligne, il n'y a donc aucun moyen de diviser le commentaire de la valeur de la chaîne brute.

Les commentaires dans une collection sont affichés ci-dessous -

key: #comment 1
   - value line 1
   #comment 2
   - value line 2
   #comment 3
   - value line 3

La combinaison de touches de raccourci pour commenter les blocs YAML est Ctrl+Q.

Si vous utilisez Sublime Text editor, les étapes pour commenter le bloc sont mentionnées ci-dessous -

Sélectionnez le bloc. Utilisez «CTRL + /» sous Linux et Windows et «CMD + /» pour le système d'exploitation Mac. Exécutez le blocage.

Notez que les mêmes étapes s'appliquent si vous utilisez Visual Studio Code Editor. Il est toujours recommandé d'utiliserSublime Text Editor pour créer des fichiers YAML pris en charge par la plupart des systèmes d'exploitation et comprend des touches de raccourci conviviales pour les développeurs.