你如何在YAML中阻止评论?

How do you do block comments in YAML?

如何评论yaml中的一块行?


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

维基百科:

Comments begin with the number sign ( # ), can start anywhere on a line, and continue until the end of the line

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

The syntax differences are subtle and seldom arise in practice: JSON allows extended charactersets like UTF-32, YAML requires a space after separators like comma, equals, and colon while JSON does not, and some non-standard implementations of JSON extend the grammar to include Javascript's /* ... */ comments. Handling such edge cases may require light pre-processing of the JSON before parsing as in-line YAML.

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

规范只描述一种标记注释的方法:

An explicit comment is marked by a"#" indicator.

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


不是想聪明点,但是如果你为你的编辑使用崇高的文本,步骤是:

  • 选择块
  • Mac上的cmd+/或Linux和Windows上的ctrl+/
  • 利润
  • 我想其他编辑器也有类似的功能。你用的是哪一个?我很乐意做些挖掘工作。


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

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

    或使用视觉块:

  • 通过ctrl+v输入可视块后,选择多行列。
  • R,然后按_注释替换选择的多行块,或按SHIFT+I_SCAKBD在选择之前插入注释字符。

  • 另一种方法:

    如果

    • 您的yaml结构有定义良好的字段供应用程序使用
    • 你可以自由地添加一些不会干扰你的应用程序的字段。

    然后

    • 在任何级别上,您都可以添加一个名为"description"、"comment"、"notes"或其他的新块文本字段

    例子:

    而不是

    1
    2
    # This comment
    # is too long

    使用

    1
    2
    3
    Description: >
     This comment
      is too long

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

    更多优势:

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

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

  • 选择要注释的行,然后
  • ctrl+shift+c
  • 要取消评论,请执行相同的步骤。


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

    M-;

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

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


    对于Windows上的Ruby Mine用户:

    在编辑器中打开文件选择块并按ctrl+对于slash,您将选择以开头的块。

    现在,如果要取消注释注释块,请再次按相同的组合键ctrl+forward slash


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

    ctrl+/

    再次按ctrl+/也可用于关闭一行或多行的注释。


    在yaml中阻止注释的唯一方法是使用另一个应用程序一次向多行添加一个(注释)标记。例如,"块注释"右键单击选项用于记事本+中选定的文本。

    Woo Images!