poner - ¿Por qué-(3 guiones/guión) en el archivo yaml?

yaml training

Question

Así que empecé a usar el archivo YAML lugar de application.properties porque es más legible. Veo en los archivos YAML que comienzan con --- . Busqué en Google y encontré la siguiente explicación.

YAML utiliza tres guiones ("---") para separar las directivas del contenido del documento. Esto también sirve para señalar el inicio de un documento si no hay directivas presentes.

Además, probé una muestra sin --- y entendí que no es obligatorio tenerlos.

Creo que no tengo una comprensión clara de la directive y el document . ¿Alguien puede explicar con un ejemplo simple?

Answer 1

Como ya descubrió, los tres guiones se utilizan para señalar el inicio de un documento , es decir:

1. Para indicar el inicio del documento después de las directivas , es decir, las líneas %YAML o %TAG según la especificación actual. Por ejemplo:

   %YAML 1.2
   %TAG !foo! !foo-types/
   ---
   myKey: myValue

2. Para indicar el inicio del documento cuando tiene varios documentos yaml en la misma secuencia , por ejemplo, un archivo yaml:

   doc 1
   ---
   doc 2

   Si el doc 2 tiene algunas directivas anteriores, entonces tenemos que usar tres puntos ... para indicar el final del doc 1 (y el comienzo de las directivas potenciales que preceden al doc 2) al analizador. Por ejemplo:

   doc 1
   ...
   %TAG !bar! !bar-types/
   ---
   doc 2

La especificación es buena para los implementadores del analizador yaml. Sin embargo, este artículo me resulta más fácil de leer desde la perspectiva del usuario.

Answer 2

No es obligatorio tenerlos si no comienza su YAML con una directiva. Si es el caso, deberías usarlos.

Echemos un vistazo a la documentación.

3.2.3.4. Directivas

Cada documento puede estar asociado a un conjunto de directivas. Una directiva tiene un nombre y una secuencia opcional de parámetros. Las directivas son instrucciones para el procesador YAML y, como todos los demás detalles de la presentación, no se reflejan en el árbol de serialización YAML ni en el gráfico de representación . Esta versión de YAML define dos directivas, "YAML" y "TAG". Todas las demás directivas están reservadas para futuras versiones de YAML.

Un ejemplo de esto también se puede encontrar en la documentación de la directiva YAML

%YAML 1.2 # Attempt parsing
# with a warning
---
"foo"