如何评论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作为你的编辑器,那么步骤是:
选择块
cmd+ /在Mac上或ctrl+ /在Linux和Windows上
利润
我想其他编辑器也有类似的功能.你在用哪一个?我很乐意做一些挖掘.
在Vim中,您可以执行以下操作之一:
评论所有行: :%s/^/#
评论专栏10 - 15: :10,15s/^/#
评论第10行到当前行: :10,.s/^/#
评论第10行到结尾: :10,$s/^/#
或使用视觉块:
输入visual block via后选择一个多行列Ctrl+v.
按,r然后#注释掉替换选择的多行块,或Shift+i#Esc在选择前插入注释字符.
另一种方法:
如果
您的YAML结构具有明确定义的字段,供您的应用使用
并且您可以自由添加其他不会弄乱您的应用的字段
然后
在任何级别,您都可以添加一个名为"描述"或"注释"或"注释"等的新块文本字段
例:
代替
# This comment # is too long
使用
Description: > This comment is too long
要么
Comment: > This comment is also too long and newlines survive from parsing!
更多优势:
如果注释变得庞大而复杂且具有重复模式,则可以将它们从纯文本块提升为对象
您的应用可能 - 将来 - 阅读或更新这些评论
如果您将Eclipse与yedit插件(.yaml文件的编辑器)一起使用,则可以通过以下方式注释掉多行:
选择要评论的行,然后
Ctrl+ Shift+C
要取消评论,请按照相同的步骤操作.
Emacs有评论-dwim(Do Do I Mean) - 只需选择块并执行:
M-;
这是一个切换 - 用它来评论和取消注释块.
如果您没有安装yaml-mode,则需要告诉Emacs使用哈希字符(#).