YAML 注释——如何在 YAML 中添加多行注释

原文： YAML Commenting – How to Add a Multiline Comment in YAML

你可以使用 YAML 文件来存储数据，其格式可以很容易被人类阅读和理解。它是一种数据序列化语言，经常被用于配置文件和应用程序之间的数据传输。

YAML 与 XML 和 JSON 类似，因为它们都可以用来存储不同格式的数据。主要区别在于它们的语法。

下面是 XML 格式的样子：

<user>
  <name>John Doe</name>
  <phone>00223344</phone>
  <age>80</age>
</user>

下面是 JSON 格式的样子：

{
  "user": {
    "name": "John Doe",
    "phone": "00223344",
    "age": 80
  }
}

这是 YAML 格式的样子：

user:
  name: John Doe
  phone: 00223344
  age: 80

上面的每一种格式都是用来存储用户的姓名、电话号码和年龄等数据的。

你可以在这篇文章中阅读更多关于 YAML 的特点、基本规则和语法，以及它与 JSON 和 XML 的区别。

在这篇文章中，你将学习 YAML 中的多行注释。

如何在 YAML 中添加多行注释

你可以出于各种原因使用注释，如记录你的代码、与他人协作、停止一个代码块的运行，等等。

你可以使用 # 符号在 YAML 文件中创建注释，即：

# The object below represents a user

user:
  name: John Doe
  email: john.doe@example.com
  age: 30

与其他一些语言不同，YAML 没有不同的格式来创建块或多行注释。

你必须在注释跨越的每一行上使用 # 符号。下面是一个例子：

# The object below is an example that represents a 
# user's name, phone number and age

user:
  name: John Doe
  email: john.doe@example.com
  age: 30

如果你在第二行去掉 #，该文本可能仍然作为注释出现，但 YAML 解析器可能会将其解释为纯文本，这可能会导致错误。

为了安全起见，请在每个注释行的开头使用 # 符号。

总结

在这篇文章中，我们讨论了 YAML。它主要用于存储和传输数据。

我们看到了如何创建内联和多行注释。在 YAML 中，# 符号被用于内联和多行注释。

Happy coding! 请查看我的博客，了解更多的编程内容。