YAML 注释
现在你已经熟悉了YAML的语法和基础知识,让我们继续深入了解它的细节。在本章中,我们将学习如何在YAML中使用注释。
YAML支持单行注释 . 下面通过一个示例来解释它的结构−
# this is single line comment.
YAML不支持多行注释 。如果您希望为多行提供注释,可以按照下面的示例所示进行操作−
# this
# is a multiple
# line comment
注释的特点
以下是YAML中注释的特点:
- 在执行期间会跳过被注释的块。
-
注释可帮助为指定的代码块添加描述。
-
注释不能出现在标量内部。
-
YAML没有包含任何转义散列符号(#)的方法,因此在多行字符串中无法将注释与原始字符串值分开。
以下是集合中的注释:
key: #comment 1
- value line 1
#comment 2
- value line 2
#comment 3
- value line 3
对于注释YAML代码块的快捷键组合是 Ctrl+Q 。
如果你使用 Sublime Text编辑器 ,下面是注释代码块的步骤:
选中代码块。在Linux和Windows上使用“CTRL + /”,在Mac操作系统上使用“CMD+/”。执行代码块。
值得注意的是,如果你使用 Visual Studio Code编辑器 ,相同的步骤也适用。建议始终使用 Sublime Text编辑器 来创建YAML文件,因为它受到大多数操作系统的支持,并包含开发者友好的快捷键。