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代码编辑器,则这些步骤也适用。始终建议使用Sublime Text Editor创建大多数操作系统支持的YAML文件,并包括对开发人员友好的快捷键。

Made with ❤️ in Chengdu. Copyright reserved 2019-2022.

蜀ICP备20006366号-1