YAML 注释

2024 年 8 月 28 日 | 3 分钟阅读

如果我们熟悉任何编码语言、数据序列化语言或编程语言,我们就知道为什么要讨论注释了。 在 YAML 中,注释的工作方式与 Splash 和许多其他语言相同。

在注释中,我们必须添加一个八角符号或一个井号和一个空格。 空格是指八角符号和实际注释之间的空格、制表符或任何间距。 注释可以放在单独的一行上。 因此,我们将在文件的顶部添加 Philly DC Host Data。

示例

我们还可以添加内联注释,因此我们将在费城的末尾提供费城的引用 ID 或引用名称,即 PHL。 当我们添加内联注释时,它们必须位于行尾。 我们不能在此处添加有关我们位置的更多信息。 因为一旦我们添加了八角符号,之后的所有内容都只是为了我们。 只要有人打开该文件并查看该文件,就会向我们表明添加到注释中的任何信息都应该只是为了人类阅读。 计算机需要或需要处理的任何实际信息都不应添加到八角符号之后。 内联注释的示例如下

示例

我们要讨论的另一件事是空白行。 空白行的示例如下

location 和 cab 之间的空格将被写成注释。 它不会特别中断任何东西。

有一些错误的使用注释的方式,我们将通过两个例子来理解。

示例 1

当我们看到上面的例子时,我们可以看到问题是八角符号和注释之间没有实际的空格。 因此,当用户处理我们的 YAML 时,它将知道这是一个注释,并且更可能的是我们会遇到“八角符号后无空格 Philly DC Host Data”的错误。

示例 2

在上面的例子中,如果我们查看我们的位置数据,我们确实在那里有一个八角符号,并且它一直延续到最后,但由于某种原因,我们的费城值被引用了。 因此,内联注释将包含在带引号的字符串中。 所以我们在评论时会犯一些更容易犯的错误。


下一个主题YAML 锚点