YAML注释


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 Editor ,则会在下面提到注释该块的步骤

选择块。在Linux和Windows上使用“CTRL + /”,在Mac操作系统上使用“CMD + /”。执行块。

请注意,如果您使用的是 Visual Studio Code, 则适用相同的步骤。始终建议使用 Sublime Text Editor 创建大多数操作系统支持的YAML文件,并包含开发人员友好的快捷键。