如何在YAML中注释一行?


当前回答

另一种方法:

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!

更多优点:

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

其他回答

对于Windows上的RubyMine用户:

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

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

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

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

或使用视觉块:

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

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

米-;

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

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

另一种方法:

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!

更多优点:

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

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