如何在 YAML 中屏蔽注释？

Question

如何在 YAML 中注释一行行？

Answer 1

YAML 支持内联注释，但不支持块注释。

来自维基百科：

注释以数字符号 (

#

) 开头，可以从一行中的任意位置开始，一直持续到行尾

与 JSON 的比较，也来自 Wikipedia：

语法差异很微妙，在实践中很少出现：JSON 允许扩展字符集，如 UTF-32，YAML 需要在逗号、等号和冒号等分隔符后有一个空格，而 JSON 则不然，并且 JSON 的一些非标准实现扩展了语法包含 Javascript 的

/* ... */

注释。处理此类边缘情况可能需要在解析为内联 YAML 之前对 JSON 进行少量预处理。

# If you want to write
# a block-commented Haiku
# you'll need three pound signs

Answer 2

规范仅描述了一种标记注释的方式：

明确的注释由“#”指示符标记。

仅此而已。没有任何块评论。

Answer 3

我并不是想聪明一点，但如果你使用 Sublime Text 或 Visual Studio Code 作为编辑器，步骤是：

1. 选择区块
2. Cmd + /（Mac）或 Ctrl + /（Linux 和 Windows）
3. 利润

我想其他编辑器也有类似的功能。您使用的是哪一款？我很乐意进行一些挖掘。

Answer 4

在 Vim 中，您可以执行以下操作之一：

• 评论所有行：

  :%s/^/#

• 评论第 10 - 15 行：

  :10,15s/^/#

• 将第 10 行注释到当前行：

  :10,.s/^/#

• 评论第10行结束：

  :10,$s/^/#

或使用视觉块：

1. 通过 Ctrl+v 进入可视块后选择多行列。
2. 按 r，然后按 # 注释掉替换所选内容的多行块，或按 Shift+i#Esc 在所选内容之前插入注释字符。

Answer 5

另一种方法：

如果

• 您的 YAML 结构具有明确定义的字段供您的应用程序使用
• 并且您可以自由添加其他字段，不会扰乱您的应用程序

然后

• 在任何级别，您都可以添加一个名为“描述”或“评论”或“注释”或其他名称的新块文本字段

示例：

而不是

# This comment
# is too long

使用

Description: >
  This comment
  is too long

或

Comment: >
    This comment is also too long
    and newlines survive from parsing!

更多优点：

1. 如果注释变得又大又复杂并且具有重复模式，您可以将它们从纯文本块提升为对象
2. 您的应用将来可能会阅读或更新这些评论

Answer 6

在 YAML 中阻止注释的一种方法是使用像 Notepad++ 这样的文本编辑器一次向多行添加 #（注释）标签。

在 Notepad++ 中，您可以使用所选文本的“块注释”右键单击选项来执行此操作。

Answer 7

Emacs 有 comment-dwim（按照我的意思做）- 只需选择块并执行：

M-；

这是一个切换开关 - 用它来注释和取消注释块。

如果您没有安装 yaml-mode，您需要告诉 Emacs 使用哈希字符 (#)。

Answer 8

对于 Windows 上的 RubyMine 用户：

• 在编辑器中打开文件。

• 选择区块并按：

  Ctrl + /,

• 您将拥有以#开头的所选块。

现在，如果您想取消注释块，请再次按相同的组合键 Ctrl + 正斜杠。

Answer 9

在 Azure DevOps 浏览器（管道 YAML 编辑器）中，

Ctrl + K + C 评论区

Ctrl + K + U 取消注释块

还有一个“切换块评论”选项，但这对我不起作用。

还有其他“奇怪”的方法：右键单击查看“命令面板”或F1

然后选择光标选项。

现在只是#的问题。

甚至更智能 [Ctrl + K] + [Ctrl + C]

Answer 10

如果您将 Eclipse 与 YEdit 插件（.yaml 文件的编辑器）一起使用，您可以通过以下方式注释掉多行：

1. 选择要注释的行，然后
2. Ctrl + Shift + C

要取消注释，请按照相同的步骤操作。

Answer 11

在 .gitlab-ci.yml 文件中，以下内容有效：

注释掉块（多行）：选择整个块部分 > Ctrl K C

要取消注释已注释掉的块（多行）：选择 整个块部分 > Ctrl K U