Reglas básicas de YAML

YAML destaca por su legibilidad, pero esa ventaja depende de respetar normas estrictas sobre espacios, mayúsculas y comentarios. Dominar estas reglas desde el inicio evita errores difíciles de diagnosticar.

3.1 Indentación y espacios

En YAML la estructura jerárquica depende de la indentación. Cada nivel se define con espacios, nunca con tabulaciones.

  • Usa siempre espacios; las tabulaciones no están permitidas.
  • Mantén una cantidad constante (2 o 4 espacios) en todo el archivo.
  • Cualquier inconsistencia provocará errores de análisis.

Ejemplo correcto (indentación consistente con 2 espacios):

producto:
  codigo: 1
  descripcion: Teclado
  precio: 15000

Ejemplo incorrecto (usa una tabulación en lugar de espacios):

producto:
	descripcion: Teclado   # <- tabulación no permitida
  precio: 15000

Los procesadores YAML informarán un error de sintaxis debido a la tabulación.

Ejemplo incorrecto (mezcla 2 y 3 espacios):

producto:
   codigo: 1      # 3 espacios
  descripcion: Teclado  # 2 espacios
   precio: 15000

La inconsistencia en la cantidad de espacios dificulta la lectura y provoca errores.

3.2 Sensibilidad a mayúsculas

Las claves y los valores de tipo texto son sensibles a mayúsculas y minúsculas. Producto, producto y PRODUCTO se consideran claves diferentes.

Ejemplo con claves distintas por su capitalización:

Producto: Teclado
producto: Mouse
PRODUCTO: Monitor

Para evitar confusiones, la convención en proyectos de software y DevOps es usar minúsculas y separar palabras con guiones medios (-) o guiones bajos (_).

Ejemplo recomendado:

producto:
  codigo: 1
  nombre_producto: Teclado
  precio: 15000

3.3 Comentarios

Los comentarios comienzan con #. Todo lo que siga en la misma línea se ignora al procesar el archivo.

Ejemplo de comentarios en líneas separadas y al final de línea:

# Este es un comentario de una sola línea
producto:
  codigo: 1        # Código interno del producto
  descripcion: PC  # Descripción del producto
  precio: 200000   # Precio en pesos

No existen comentarios multilínea tipo /* ... */. Para desactivar temporalmente un bloque, comenta línea por línea.

Ejemplo de bloque comentado:

#producto:
#  codigo: 2
#  descripcion: Mouse
#  precio: 9000

3.4 Buenas prácticas

  • Usa siempre espacios en lugar de tabs; dos espacios por nivel es una elección popular.
  • Mantén la indentación uniforme en todo el archivo.
  • Prefiere minúsculas para las claves y separadores consistentes (- o _).
  • Añade comentarios claros y concisos sin saturar el archivo.

Siguiendo estas reglas básicas podrás escribir archivos YAML confiables, fáciles de leer y sin errores de sintaxis.

Retornar