¿Cómo comento un bloque de líneas en YAML?
¿Cómo comento un bloque de líneas en YAML?
Respuestas:
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 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 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 lo hace, y algunas implementaciones no estándar de JSON extienden la gramática a incluir los
/* ... */
comentarios de Javascript . El manejo de estos casos extremos puede requerir un preprocesamiento ligero 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
La especificació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.
No trato de ser inteligente al respecto, pero si usa Sublime Text para su editor, los pasos son:
Me imagino que otros editores también tienen una funcionalidad similar. Cual estas usando? Me encantaría hacer algunas excavaciones.
En Vim puedes hacer uno de los siguientes:
:%s/^/#
:10,15s/^/#
:10,.s/^/#
:10,$s/^/#
o usando bloque visual:
"Vim, I did a thing. do it here, and here and here and here and here..."
:
y escribir s/^/#
para comentar la selección actual.
qqI#<esc>jq
entonces @Q@Q@Q@Q@Q@Q
(porque es más rápido no soltar la tecla shift), es un hábito que puede extender a tareas mucho más complejas. Empieza pequeño. Practica a menudo. Pronto creará macros muy complejas perfectamente primer intento. Si borra el registro primero qqq
, puede incluir @q
antes del último q
para obtener la recursividad (pero solo hasta el final del archivo).
@q
, simplemente puedes hacerlo 6@q
o 10000@q
si quieres.
:h count
multiplicadores. Pero para mí, visualmente cualquier cosa mayor de 6 y tengo que hacerlo a mano porque no puedo adivinarlo de manera confiable. La excepción es que sé que tengo más de 60 filas en mi terminal, así que lo usaré para estimar las reproducciones de marco muy grandes. Como beneficio adicional, voy a sugerir a todos que aprendan sobre :h gn
lo que facilita la .
repetición en las coincidencias de búsqueda. Ver vimcasts.org/episodes/operating-on-search-matches-using-gn
Un enfoque alternativo:
Si
entonces
Ejemplo:
En vez 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:
Una forma de bloquear comentarios en YAML es mediante el uso de un editor de texto como Notepad ++ para agregar una etiqueta # (comentario) a varias líneas a la vez.
En Notepad ++ puede hacerlo utilizando la opción de clic derecho "Bloquear comentario" para el texto seleccionado.
Si está utilizando Eclipse con el complemento yedit (un editor para archivos .yaml), puede comentar varias líneas de la siguiente manera:
Y para dejar de comentar, siga los mismos pasos.
Para usuarios de Ruby Mine en Windows:
Abrir archivo en el editor Seleccione el bloque y presione Ctrl+ forward slash, habrá seleccionado el bloque que comienza con #.
Ahora, si desea descomentar el bloque comentado, presione la misma combinación de teclas Ctrl+ forward slashnuevamente
Emacs tiene comment-dwim (Haz lo que quiero decir): solo selecciona el bloque y haz un:
METRO-;
Es una palanca: úsela para comentar y descomentar bloques.
Si no tiene instalado el modo yaml, deberá decirle a Emacs que use el carácter hash (#).
Para los usuarios de Visual Studio Code (VSCode), el atajo para comentar varias líneas es resaltar las líneas que desea comentar y luego presionar:
ctrl + /
Presionar ctrl+ /nuevamente también se puede usar para desactivar los comentarios de una o más líneas seleccionadas.
En el navegador Azure Devops (editor de canal yaml),
Ctrl+ K+ CBloque de comentarios
Ctrl+ K+ UBloque sin comentarios
También hay una opción de 'Alternar comentario de bloque' pero esto no funcionó para mí.
También hay otras formas 'extrañas': haga clic derecho para ver 'Paleta de comandos' o F1
Luego elija una opción de cursor.
Ahora es solo cuestión de #
o incluso más inteligente [ Ctrl+ k] + [ Ctrl+ c]