Saltar al contenido

YAML – Comentarios

septiembre 29, 2021

Ahora que se siente cómodo con la sintaxis y los conceptos básicos de YAML, avancemos en sus detalles. En este capítulo, veremos cómo usar los comentarios en YAML.

YAML admite comentarios de una sola línea. Su estructura se explica a continuación con la ayuda de un ejemplo:

# this is single line comment.

YAML no admite comentarios de varias líneas. Si desea proporcionar comentarios para varias líneas, puede hacerlo como se muestra en el siguiente ejemplo:

# this
# is a multiple
# line comment

Características de los comentarios

Las características de los comentarios en YAML se detallan a continuación:

  • Se omite un bloque comentado durante la ejecución.

  • Los comentarios ayudan a agregar una descripción para el bloque de código especificado.

  • Los comentarios no deben aparecer dentro de los escalares.

  • YAML no incluye ninguna forma de escapar del símbolo de almohadilla (#), por lo que dentro de una cadena de varias líneas, por lo que no hay forma de dividir el comentario del valor de la cadena sin procesar.

Los comentarios dentro de una colección se muestran a continuación:

key: #comment 1
   - value line 1
   #comment 2
   - value line 2
   #comment 3
   - value line 3

La combinación de teclas de método abreviado para comentar bloques YAML es Ctrl + Q.

Si esta usando Editor de texto sublime, los pasos para comentar el bloque se mencionan a continuación:

Seleccione el bloque. Utilice «CTRL + /» en Linux y Windows y «CMD + /» para el sistema operativo Mac. Ejecuta el bloque.

Tenga en cuenta que los mismos pasos son aplicables si está utilizando Editor de código de Visual Studio. Siempre se recomienda utilizar Editor de texto sublime para crear archivos YAML, ya que es compatible con la mayoría de los sistemas operativos e incluye teclas de método abreviado fáciles de usar para desarrolladores.

close