YAML注释

管理员 YAML教程

本文章向大家介绍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编辑器,则会在下面提到注释该块的步骤 -
选择块,在Linux和Windows上使用CTRL + /,在Mac操作系统上使用CMD + /

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