- YAML 教程
- YAML - 首页
- YAML – 简介
- YAML – 基础
- YAML – 缩进和分隔
- YAML - 注释
- YAML – 集合和结构
- YAML – 标量和标签
- YAML – 完整示例
- YAML – 过程
- YAML – 信息模型
- YAML – 语法字符
- YAML – 语法基元
- YAML – 字符流
- YAML – 节点属性
- YAML – 块标量标题
- YAML – 流式风格
- YAML – 块式风格
- YAML – 序列风格
- YAML – 流式映射
- YAML – 块序列
- YAML – Failsafe 模式
- YAML – JSON 模式
- YAML 有用资源
- 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 Code 编辑器,则步骤相同。始终建议使用 Sublime Text 编辑器创建 YAML 文件,因为它受大多数操作系统支持,并包含对开发人员友好的快捷键。
广告