Pregunta ¿Cómo se bloquea el comentario en yaml?


¿Alguien sabe cómo comentar un bloque de líneas en yaml?


953
2018-02-16 21:42


origen


Respuestas:


YAML admite comentarios en línea, pero no admite comentarios en bloque.

De Wikipedia:

Los comentarios comienzan con el signo de número ( # ), puede comenzar en cualquier lugar de una línea y continuar 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 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 amplían la gramática a incluir Javascript /* ... */ comentarios El manejo de tales casos extremos puede requerir un preprocesamiento liviano del JSON antes del análisis como YAML en línea.

# If you want to write
# a block-commented Haiku
# you'll need three pound signs

1455
2018-02-16 21:47



los especulación solo describe una forma de marcar comentarios:

Un comentario explícito está marcado con un indicador "#".

Eso es todo. No hay comentarios de bloque


146
2018-02-16 21:52



No intento ser inteligente al respecto, pero si usa Sublime Text para su editor, los pasos son:

  1. Seleccione el bloque
  2. CMD + / en Mac o CTRL + / en Linux y Windows
  3. Lucro

Me imagino que otros editores también tienen una funcionalidad similar. Cual estas usando? Estaría feliz de hacer algunas excavaciones.


82
2018-05-22 18:20



En Vim puedes hacer una de las siguientes cosas:

  • Comenta todas las líneas: :%s/^/#
  • Líneas de comentario 10 - 15: :10,15s/^/# 
  • Comenta la línea 10 a la línea actual: :10,.s/^/#
  • Comenta la línea 10 hasta el final: :10,$s/^/#

o usando bloque visual:

  1. Seleccione una columna de varias líneas después de ingresar el bloque visual a través de Ctrl + v.
  2. prensa r seguido por # comentar el bloque de líneas múltiples que reemplaza la selección, o Shift + i#Esc para insertar caracteres de comentarios antes de la selección.

48
2017-07-09 19:25



Si está utilizando Eclipse con el plugin yedit (un editor para archivos .yaml), puedes comentar múltiples líneas por

  1. seleccionando líneas para ser comentadas, y luego
  2. Ctrl + shift + c

y para dejar de comentar, siga los mismos pasos.


7
2017-07-05 13:42



Emacs tiene comment-dwim (Haz lo que quiero decir) - simplemente selecciona el bloque y haz un:

METRO-;

Es un alternar: úsalo para comentar Y descomentar bloques.

Si no tiene instalado yaml-mode, tendrá que decirle a Emacs que use el carácter hash (#).


5
2017-11-20 00:17



Para usuarios de Ruby Mine en Windows:

Abrir archivo en editor Seleccione el bloque y presione Ctrl+barra inclinada, habrá seleccionado el bloque que comienza con #.

Ahora, si desea des-comentar el bloque comentado, presione la misma combinación de teclas Ctrl+barra inclinada de nuevo


4
2017-12-25 18:13



Un enfoque alternativo:

Si

  • su estructura YAML tiene campos bien definidos para ser usados ​​por su aplicación
  • Y puedes agregar libremente campos adicionales que no se estropearán con tu 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:

  1. Si los comentarios se vuelven grandes y complejos y tienen un patrón repetitivo, puede promocionarlos desde bloques de texto sin formato a objetos
  2. Su aplicación puede, en el futuro, leer o actualizar esos comentarios

3
2018-04-26 07:45



La única manera de bloquear comentarios en YAML es usar otra aplicación para agregar una etiqueta # (comentario) a varias líneas a la vez. Un ejemplo de esto es la opción de clic derecho del "comentario de bloque" para el texto seleccionado en Notepad ++.

Woo Images!


2
2018-05-04 00:10