如何在YAML中注释一行?


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

来自维基百科:

注释以数字符号(#)开头,可以从一行的任何位置开始,并一直持续到该行的结尾

与JSON的比较,同样来自维基百科:

语法差异很细微,在实践中很少出现:JSON允许扩展字符集(如UTF-32),YAML需要逗号、等号和冒号等分隔符后的空格,而JSON则不需要,JSON的一些非标准实现将语法扩展到包括Javascript的/*…*/评论。处理这种边缘情况可能需要在解析为内联YAML之前对JSON进行少量预处理。

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

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

显式注释由“#”指示符标记。

这就是全部。没有任何块注释。


我并不是想聪明一点,但如果您在编辑器中使用Sublime Text,步骤如下:

选择块Mac上的Cmd+/或Linux和Windows上的Ctrl+/利润

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


在Vim中,您可以执行以下操作之一:

注释所有行::%s/^/#注释行10-15::10,15s/^/#注释行10到当前行::10,.s/^/#注释行10结束::10,$s/^/#

或使用视觉块:

通过Ctrl+v输入视觉块后,选择多行列。按r后跟#以注释掉替换所选内容的多行块,或按Shift+i#Esc在所选内容之前插入注释字符。


对于Windows上的RubyMine用户:

在编辑器中打开文件。选择块并按:Ctrl+/,您将得到以#开头的选定块。

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


Emacs有注释dwim(Do What I Mean)-只需选择块并执行:

米-;

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

如果没有安装yaml模式,则需要告诉Emacs使用哈希字符(#)。


在YAML中阻止注释的一种方法是使用文本编辑器(如Notepad++)将#(comment)标记一次添加到多行。

在Notepad++中,您可以使用选中文本的“阻止注释”右键单击选项来完成此操作。


如果您将Eclipse与YEdit插件(一个.yaml文件的编辑器)一起使用,您可以通过以下方式注释多行:

选择要注释的行,然后Ctrl+Shift+C

要取消注释,请执行相同的步骤。


另一种方法:

If

您的YAML结构有定义良好的字段供您的应用程序使用您可以自由添加其他字段,而不会干扰您的应用程序

then

在任何级别上,您都可以添加一个名为“说明”、“注释”或“注释”等的新块文本字段

例子:

而不是

# This comment
# is too long

use

Description: >
  This comment
  is too long

or

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

更多优点:

如果注释变得大而复杂,并且具有重复模式,则可以将其从纯文本块升级为对象你的应用将来可能会阅读或更新这些评论


在Azure DevOps浏览器(管道YAML编辑器)中,

Ctrl+K+C注释块

Ctrl+K+U取消注释块

还有一个“切换块注释”选项,但这不适用于我。

还有其他“奇怪”的方式:右键单击以查看“命令调色板”或F1

然后选择光标选项。

现在只是#的问题。

或者更聪明的[Ctrl+K]+[Ctrl+C]


在.gitlab-ci.yml文件中,以下操作有效:

注释掉块(多行):选择整个块部分>Ctrl K C取消注释已注释的块(多行):选择整个块段>Ctrl K U