如何在yaml中阻止评论?

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

从 Wikipedia :

注释以数字符号开头( # ),可以从一行的任何地方开始,并一直持续到行的末尾

与json的比较 Wikipedia :

语法差异是微妙的,在实践中很少出现:json允许像utf-32这样的扩展字符集,yaml在逗号、equals和冒号等分隔符后面需要一个空格,而json不需要,json的一些非标准实现扩展了语法以包括javascript的 /* ... */ 评论。处理这种边缘情况可能需要在将json解析为内联yaml之前对其进行轻微的预处理。

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

这个 spec 仅描述一种标记注释的方式:

显式注释由一个指示符标记。

这就是全部.没有块注释。

不是想聪明点,但是如果你在编辑器中使用Sublime文本,步骤如下:

1. 选择块
2. CMD + / 关于MAC或 CTRL + / 在Linux和Windows上
3. 利润

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

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

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

或使用可视块:

1. 输入可视块后选择多行列 CTRL+V .
2. 出版社 R 然后 γ 要注释掉替换所选内容的多行块,或 移位+i γ ESC 在选定内容之前插入注释字符。

另一种方法:

如果

• 您的yaml结构有定义良好的字段供您的应用程序使用
• 你还可以自由添加不会影响你的应用程序的额外字段

然后

• 在任何级别上,您都可以添加一个名为“description”或“comment”或“notes”之类的新块文本字段

例子:

而不是

# 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. 你的应用可能-在未来-阅读或更新这些评论

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

1. 选择要注释的行,然后
2. Ctrl键 + 移位 + C

要取消评论,请遵循相同的步骤。

Emacs有注释dwim(按我的意思做)-只需选择块并执行以下操作:

M;

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

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

对于windows上的ruby mine用户:

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

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

在yaml中阻止注释的唯一方法是使用另一个应用程序一次向多行添加35;(注释)标记。这方面的一个例子是notepad++中选定文本的“block comment”右键单击选项。

对于Visual Studio代码(VScode)用户,注释多行的快捷方式是突出显示要注释的行,然后按:

CTRL + /

紧迫的 CTRL + / 同样也可以用于关闭一个或多个选定行的注释。