¿Cómo comento un bloque de líneas en YAML?
YAML admite comentarios en línea, pero no admite comentarios en bloque.
De Wikipedia:
Los comentarios comienzan con el signo de número ( #
), pueden empezar en cualquier parte de una línea y continuar hasta el final de la línea.
Una comparación con JSON, también de Wikipedia:
Las diferencias sintácticas son sutiles y rara vez surgen en la práctica: JSON permite conjuntos de caracteres extendidos como UTF-32, YAML requiere un espacio después de separadores como coma, igual y dos puntos mientras que JSON no, y algunas implementaciones no estándar de JSON extienden la gramática para incluir los comentarios /* ... */
de Javascript. */` de Javascript. La gestión de estos casos extremos puede requerir un ligero preprocesamiento del JSON antes de analizarlo como YAML en línea.
# If you want to write
# a block-commented Haiku
# you'll need three pound signs
No es por hacerme el listo, pero si usas Sublime Text como editor, los pasos son:
Me imagino que otros editores también tienen funciones similares. ¿Cuál utilizas? Estaré encantado de investigar un poco.
En Vim puedes hacer una de las siguientes cosas:
:%s/^/#
:10,15s/^/#
:10,.s/^/#
:10,$s/^/#
o usando el bloqueo visual:
seguido de <kbd;#</kbd;#; para comentar el bloque de líneas múltiples que sustituye a la selección, o bien, pulse para insertar caracteres de comentario antes de la selección.
Un enfoque alternativo:
Si
entonces
Ejemplo:
En lugar de
# This comment
# is too long
use
Description: >
This comment
is too long
o
Comment: >
This comment is also too long
and newlines survive from parsing!
Más ventajas:
Su aplicación puede -en el futuro- leer o actualizar esos comentarios
Si utiliza Eclipse con el plugin yedit (un editor de archivos .yaml), puede comenzar con varias líneas:
Ctrl</kbd..;
Y para des-comentar, sigue los mismos pasos.
Emacs ha comenzado -dwim (Do What I Mean) - sólo tienes que seleccionar el bloque y hacer un: M-;
Es una palanca - úsala para comentar y descomentar los bloques.
Si no tienes instalado el modo yaml, tendrás que decirle a Emacs que use el carácter hash (#).
Para los usuarios de Mina Rubí en Windows:
Abrir archivo en el editor Seleccione el bloque y pulse Ctrl</kbd;/kbd;+<kbd;/kbd;/kbd;/, habrá seleccionado un bloque que comienza con #.
Ahora, si quiere des-comentar el bloque comentado, presione la misma combinación de teclas..; otra vez
Para los usuarios de Visual Studio Code (VSCode), el atajo para comentar varias líneas es resaltar las líneas que quieres comentar y luego presionar:
ctrl</kbd..;
Presionando: <kbd;ctrl</kbd;/..;
Una forma de bloquear los comentarios en YAML es usando un editor de texto como Notepad++ para añadir una etiqueta # (comentario) a varias líneas a la vez.
En Notepad++ puedes hacerlo usando el "Bloquear Comentario" la opción de hacer clic con el botón derecho del ratón para el texto seleccionado.
[![¡Imágenes Woo!][1]]][1]