¿Cómo comento un bloque de líneas en YAML?
Respuestas
¿Demasiados anuncios?
YAML admite comentarios en línea, pero no admite comentarios de bloque.
De Wikipedia:
Los comentarios comienzan con el signo numeral (
#), pueden comenzar en cualquier parte 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 juegos de caracteres extendidos como UTF-32, YAML requiere un espacio después de separadores como coma, igual y dos puntos, mientras que JSON no lo hace y algunas implementaciones no estándar de JSON extienden la gramática para incluir comentarios de Javascript
/* ... */. Manejar tales casos especiales puede requerir un ligero preprocesamiento del JSON antes de analizarlo como YAML en línea.
# Si quieres escribir
# un Haiku con comentario de bloque
# necesitarás tres signos de numeral
eugene y
Puntos
37378
La especificación sólo describe una forma de marcar comentarios:
Un comentario explícito se marca con un indicador "#".
Eso es todo. No hay comentarios de bloque.
Dimitrios Tsalkakis
Puntos
611
Un enfoque alternativo:
Si
- la estructura YAML tiene campos bien definidos para ser utilizados por su aplicación
- Y puede agregar libremente campos adicionales que no interferirán con 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
# Este comentario
# es muy largouse
Descripción: >
Este comentario
es muy largoo
Comentario: >
Este comentario también es muy largo
¡y los saltos de línea sobreviven al análisis!Más ventajas:
- Si los comentarios se vuelven grandes y complejos y tienen un patrón repetitivo, puede promoverlos de bloques de texto simples a objetos
- Su aplicación puede -en el futuro- leer o actualizar esos comentarios
Kyle Carlson
Puntos
898
No estoy tratando de ser listo al respecto, pero si usas Sublime Text como tu editor, los pasos son:
- Selecciona el bloque
- Cmd + / en Mac o Ctrl + / en Linux y Windows
- Beneficio
Imagino que otros editores también tienen funcionalidades similares. ¿Cuál estás usando? Estaría encantado de investigar.
Nathan Meyer
Puntos
307
Una forma de bloquear los comentarios en YAML es usando un editor de texto como Notepad++ para agregar una etiqueta # (comentario) a varias líneas a la vez.
En Notepad++ puedes hacer eso usando la opción de clic derecho "Comentario de bloque" para el texto seleccionado.
- Ver respuestas anteriores
- Ver más respuestas
