为什么在yaml文件中使用--（3个破折号/连字符）？

Question

所以我刚刚开始使用YAML文件而不是application.properties，因为它更具可读性。我在YAML文件中看到它们以---开头。我谷歌了一下，找到了下面的解释。

YAML使用三个破折号（“--”）将指令与文档内容分开。如果没有指令，这也可以作为文档开始的信号。

此外，我尝试了一个没有---的示例，并理解拥有它们不是强制性的。

我想我对指令和文档没有清楚的理解。谁能用一个简单的例子解释一下？

Answer 1

如果您没有以指令开始您的YAML，则不必强制使用它们。如果是这样，你应该使用它们。

我们来看看留档

3.2.3.4. 指令

每个文档都可能与一组指令相关联。指令有一个名称和一个可选的参数序列。指令是对YAML处理器的指令，与所有其他表示细节一样，不会反映在YAML序列化树或表示图中。此版本的YAML定义了两个指令，“YAML”和“TAG”。所有其他指令都保留给YAML的未来版本。

这方面的一个示例也可以在指令YAML的留档中找到

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

Answer 2

正如您已经发现的那样，三个破折号用于表示文档的开始，即：

>

指示文件在指令之后开始，即根据当前规范的%YAML或%标记行。例如：

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

当您在同一个流中有多个yaml文档（例如，一个yaml文件）时，要发出文档开始的信号：

doc 1
---
doc 2

如果doc 2有一些前面的指令，那么我们必须使用三个点 向解析器指示文档1的结束（以及文档2之前的潜在指令的开始）。例如：

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

该规范适用于yaml解析器实现。然而，我发现从用户角度来看，这篇文章更容易阅读。