Comment faire pour bloquer les commentaires dans YAML?
Comment puis-je commenter un bloc de lignes dans YAML?
9 réponses
YAML supporte les commentaires en ligne, mais ne supporte pas les commentaires de bloc.
De Wikipedia :
les commentaires commencent par le signe du numéro (
#), peuvent commencer n'importe où sur une ligne, et continuent jusqu'à la fin de la ligne
une comparaison avec JSON, également de Wikipedia :
les différences de syntaxe sont subtiles et rarement surgies dans la pratique: JSON permet des jeux de caractères étendus comme UTF-32, YAML nécessite un espace après les séparateurs comme virgule, égaux, et colon tandis que JSON ne le fait pas, et certaines implémentations non-standard de JSON étendent la grammaire pour inclure les commentaires
/* ... */de Javascript. La manipulation de tels cas de bord peut nécessiter un prétraitement léger du JSON avant l'analyse comme YAML en ligne.
# If you want to write
# a block-commented Haiku
# you'll need three pound signs
le spec ne décrit qu'une seule façon de marquer les commentaires:
explicite commentaire est marqué par un "#" indicateur.
C'est tout. Il n'y a pas de commentaires en bloc.
ne pas essayer d'être intelligent à ce sujet, mais si vous utilisez le texte Sublime pour votre éditeur, les étapes sont:
- sélectionner le bloc
-
CMD + /sur Mac ouCTRL + /sur Linux et Windows - à but Lucratif
j'imagine que d'autres éditeurs ont des fonctionnalités similaires. Lequel utilisez-vous? Je serais ravi de creuser un peu.
dans Vim vous pouvez faire l'un des suivants:
- Commenter toutes les lignes:
:%s/^/# - Comment lines 10-15:
:10,15s/^/# - Commentaire de la ligne 10 à la ligne en cours:
:10,.s/^/# - ligne de commentaire 10 à la fin:
:10,$s/^/#
ou en utilisant le bloc visuel:
- sélectionner une colonne à lignes multiples après avoir entré visual block via Ctrl+v .
- presser r suivi de # pour commenter le bloc à lignes multiples remplaçant la sélection, ou Shift+i # Esc pour insérer des caractères de commentaire avant la sélection.
si vous utilisez Eclipse avec le plugin yedit (un éditeur pour .yaml files), vous pouvez commenter plusieurs lignes par:
- sélectionner les lignes à commenter, puis
- Ctrl + Shift + C
et à un-comment, suivre les mêmes étapes.
Emacs a commentaire-dwim ( faire ce que je veux dire) - il suffit de sélectionner le bloc et de faire un:
M -;
c'est une bascule - utilisez-le pour commenter et décommenter les blocs.
si vous n'avez pas le mode yaml installé, vous devrez dire à Emacs d'utiliser le caractère hash (#).
une autre approche:
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 seront pas gâcher avec votre application
puis
- à n'importe quel niveau vous pouvez ajouter un bloc de texte champ nommé comme "Description" ou "Commentaire" ou "Notes" ou peu importe
exemple:
au lieu de
# This comment
# is too long
utiliser
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 ont un motif répétitif, vous pouvez les promouvoir de blocs de texte en clair à des objets
- Votre application peut-à l'avenir-lire ou mettre à jour ces commentaires""
pour les utilisateurs de Ruby Mine sous Windows:
ouvrir le fichier dans editor Sélectionnez le bloc et appuyez sur Ctrl + barre oblique , vous aurez le bloc sélectionné, en commençant par #.
maintenant si vous voulez désactiver le bloc commenté, appuyez sur la même combinaison de touches Ctrl + slash avant encore
la seule façon de bloquer les commentaires dans YAML est d'utiliser une autre application pour ajouter une balise # (commentaire) à plusieurs lignes à la fois. Un exemple de ceci est l'option "Block Comment" du clic droit pour le texte sélectionné dans Notepad++.
