YAML – 注释

YAML是一种轻量级的数据交换格式，极易阅读书写。它的语法规则非常简单，同时也内置了很多实用的功能。其中，注释是YAML的一个非常实用的功能，通过注释我们可以更好地维护和理解配置文件。

注释的规则

注释在YAML中有两种表示方式，分别是：行内注释和块注释。

行内注释

行内注释是通过#符号进行表示的，#符号后面的内容都会被解析器忽略。

示例代码：

# 这是一个行内注释
key1: value1 # 这是key1的值

在上面的示例中，行内注释使用#符号来表示，后面跟着的内容会被解析器忽略。我们同时可以在一些行的末尾加上注释，这对于维护大型的YAML文件非常实用。

块注释

块注释是一种多行注释，使用起来比较简单。块注释必须使用新行来进行表示，其语法为：格式为英文#或空格加*或-，然后是注释的内容，注释内容前后都要换行。

示例代码：

# 这是一个块注释
# 
# 下面是一些列表
- 蔬菜
- 水果
# 我们也可以进行嵌套
# - 食物

在上面的示例中，使用#符号表示注释，可以在#符号后面的任意位置书写注释内容，直到换行或者文件结束。

注释的注意事项

在YAML中，注释的语法和其他大部分编程语言一样，需要注意下面几点：

行内注释必须使用#符号进行表示；
块注释使用#符号和*或-符号表示；
注释前面必须有空格，否则注释内容会被解析成其他内容；
在YAML中，注释可以出现在任何位置，但不可以出现在字符串的中间；
注释可以嵌套，但是不推荐使用。

示例

下面是一个包含注释的YAML文件的示例：

# 配置文件
# 
# 下面是一些基本的设置
app.name: "demo" # 应用程序名称
app.host: "localhost" # 应用程序主机名
app.port: 8080 # 应用程序端口
app.debug: true # 是否输出调试信息

# 数据库配置项
# 
# 数据库地址
db.host: "localhost"
# 数据库端口号
db.port: 3306
# 数据库名
db.name: "database"
# 数据库用户名
db.user: "root"
# 数据库密码
db.password: "password"