comments - yaml array of objects
¿Cómo bloqueas los comentarios en YAML? (9)
Emacs tiene comentarios-dwim (Haz lo que quiero decir) - simplemente selecciona el bloque y haz una:
METRO-;
Es un conmutador, utilícelo para comentar Y descomprimir bloques.
Si no tiene el modo yaml instalado, deberá decirle a Emacs que use el carácter hash (#).
¿Cómo comento un bloque de líneas en YAML?
En Vim puedes hacer uno de los siguientes:
- Comenta todas las líneas::
:%s/^/# - Líneas de comentarios 10 - 15
:10,15s/^/# - Comentario de la línea 10 a la línea actual
:10,.s/^/# - Comentario de la línea 10 al final::
:10,$s/^/#
o utilizando el bloque visual:
- Seleccione una columna de varias líneas después de ingresar el bloque visual a través de Ctrl + v .
- Presione r seguido de # para comentar el bloque de múltiples líneas que reemplaza la selección, o Shift + i # Esc para insertar caracteres de comentario antes de la selección.
La spec solo describe una forma de marcar comentarios:
Un comentario explícito está marcado con un indicador "#".
Eso es todo. No hay comentarios en bloque.
No intente ser inteligente al respecto, pero si usa Sublime Text para su editor, los pasos son:
- Selecciona el bloque
-
CMD + /en Mac oCTRL + /en Linux y Windows - Lucro
Me imagino que otros editores también tienen una funcionalidad similar. Cual estas usando? Yo estaría feliz de hacer algunas excavaciones.
Para usuarios de Ruby Mine en Windows:
Abrir archivo en el editor Seleccione el bloque y presione Ctrl + barra diagonal hacia adelante , habrá seleccionado el bloque que comienza con #.
Ahora, si desea anular el comentario del bloque comentado, presione nuevamente la misma combinación de teclas Ctrl + barra diagonal hacia adelante
Si está utilizando Eclipse con el complemento yedit (un editor para archivos .yaml), puede comentar varias líneas haciendo lo siguiente:
- seleccionando líneas para ser comentadas, y luego
- Ctrl + Shift + C
Y para dejar de comentar, sigue los mismos pasos.
YAML admite comentarios en línea, pero no admite comentarios de bloque.
De Wikipedia :
Los comentarios comienzan con el signo de número (
#), pueden comenzar en cualquier lugar de una línea y continúan hasta el final de la línea
Una comparación con JSON, también de Wikipedia :
Las diferencias de sintaxis 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, iguales y dos puntos, mientras que JSON no lo hace, y algunas implementaciones no estándar de JSON extienden la gramática a incluir Javascript
/* ... */comments. El manejo de estos casos de borde puede requerir un ligero preprocesamiento de JSON antes de analizar como YAML en línea.
# If you want to write
# a block-commented Haiku
# you''ll need three pound signs
Un enfoque alternativo:
Si
- su estructura YAML tiene campos bien definidos para ser utilizados por su aplicación
- Y puede agregar libremente campos adicionales que no estropearán su aplicación.
entonces
- en cualquier nivel puede agregar un nuevo campo de texto de bloque llamado "Descripción" o "Comentario" o "Notas" o lo que sea
Ejemplo:
En lugar de
# This comment
# is too long
utilizar
Description: >
This comment
is too long
o
Comment: >
This comment is also too long
and newlines survive from parsing!
Más ventajas:
- Si los comentarios se vuelven grandes y complejos y tienen un patrón de repetición, puede promoverlos de bloques de texto sin formato a objetos.
- Su aplicación puede, en el futuro, leer o actualizar esos comentarios.