如何在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

其他回答

另一种方法:

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

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

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

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

对于Windows上的RubyMine用户:

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

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