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

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

明确的评论标有“＃”指示符。

这就是全部。没有阻止评论。

Answer 3

不要试图聪明一点，但如果你使用Sublime Text作为你的编辑器，那么步骤是：

选择块
cmd + / 或Linux上的 ctrl + / ＆amp;视窗
利润

我想其他编辑器也有类似的功能。你在用哪一个？我很乐意做一些挖掘。

Answer 4

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

评论所有行：:%s/^/#
评论专栏10 - 15：:10,15s/^/#
将第10行评论为当前行：:10,.s/^/#
评论第10行到结尾：:10,$s/^/#

或使用视觉块：

通过 Ctrl + v 进入视觉区后选择一个多行列。
按 r ，然后按＃注释掉替换选区的多行块，或 Shift + i ＃< / kbd> 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!

更多优势：

如果评论变得庞大而复杂且具有重复模式，则可以将它们从纯文本块提升为对象

您的应用可能 - 将来 - 阅读或更新这些评论

Answer 6

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

选择要评论的行，然后
Ctrl + Shift + C

要取消评论，请按照相同的步骤操作。

Answer 7

Emacs有评论-dwim（Do Do I Mean） - 只需选择块并执行：

米 - ;

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

如果你没有安装yaml-mode，你需要告诉Emacs使用哈希字符（＃）。

Answer 8

对于Windows上的Ruby Mine用户：

在编辑器中打开文件选择块并按 Ctrl + 正斜杠，您将选择以＃开头的块。

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

Answer 9

在YAML中阻止评论的唯一方法是使用另一个应用程序一次向多行添加＃（注释）标记。这方面的一个例子是＆＃34; Block Comment＆＃34;右键单击Notepad ++中所选文本的选项。

Answer 10

对于Visual Studio Code（VSCode）用户，注释掉多行的快捷方式是突出显示要注释的行，然后按：

ctrl + /

再次按 ctrl + / 还可用于关闭一个或多个选定行的注释。

Answer 11

在Azure Devops浏览器（管道yaml编辑器）中，

Ctrl + K + C 注释框

Ctrl + K + U 注释块

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

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

然后选择一个光标选项。

现在只需要＃

或更聪明的[ Ctrl + k ] + [ Ctrl + c ]

Answer 12

在 .gitlab-ci.yml 文件中以下作品::

<块引用>

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

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

你如何在YAML中阻止评论？

12 个答案: