如何评论YAML中的一行线?
不要试图理解它,但如果你使用Sublime Text作为你的编辑器,步骤是:
选择块Mac上为
CMD + / ,Linux和Windows上为 CTRL + /
CMD + /
CTRL + /
利润
我想其他编辑也有类似的功能 . 你在用哪一个?我很乐意做一些挖掘工作 .
spec仅描述了一种标记注释的方法:
显式注释标有“#”指示符 .
就这样 . 没有块评论 .
An alternative approach:
如果
您的YAML结构具有明确定义的字段供您的应用使用
并且您可以自由添加其他不会弄乱您的应用的字段
然后
Example:
代替
# This comment # is too long
使用
Description: > This comment is too long
要么
Comment: > This comment is also too long and newlines survive from parsing!
More advantages:
如果注释变得庞大而复杂且具有重复模式,则可以将它们从纯文本块提升为对象
您的应用可能 - 将来 - 阅读或更新这些评论
Emacs有评论-dwim(Do Do I Mean) - 只需选择块并执行:
M-;
这是一个切换 - 用它来评论和取消注释块 .
如果您没有安装yaml-mode,则需要告诉Emacs使用哈希字符(#) .
YAML支持内联注释,但不支持块注释 .
从Wikipedia开始:
注释以数字符号(#)开头,可以从一行的任何地方开始,并一直持续到行尾
与JSON的比较,也来自Wikipedia:
语法差异很微妙,在实践中很少出现:JSON允许扩展字符集,如UTF-32,YAML需要在分隔符之后的空格,如逗号,等号和冒号,而JSON不需要,并且一些非标准的JSON实现扩展语法包括Javascript的/ * ... * /评论 . 处理此类边缘情况可能需要在解析为内联YAML之前对JSON进行轻度预处理 .
# If you want to write # a block-commented Haiku # you'll need three pound signs
在Vim中,您可以执行以下操作之一:
评论所有行: :%s/^/#
:%s/^/#
评论专栏10 - 15: :10,15s/^/#
:10,15s/^/#
注释第10行到当前行: :10,.s/^/#
:10,.s/^/#
注释第10行结束: :10,$s/^/#
:10,$s/^/#
或使用视觉块:
通过Ctrl v输入可视块后选择一个多行列 .
按r后跟#以注释掉替换选择的多行块,或按Shift i#Esc在选择前插入注释字符 .
如果您将Eclipse与yedit插件(.yaml文件的编辑器)一起使用,则可以通过以下方式注释掉多行:
选择要评论的行,然后
Ctrl Shift C.
要取消评论,请按照相同的步骤操作 .
对于Windows上的Ruby Mine用户:
在编辑器中打开文件选择块并按Ctrl Forward斜杠,您将选择以#开头的块 .
现在,如果要取消注释已注释的块,请按相同的组合键再次按Ctrl键
在YAML中阻止评论的唯一方法是使用另一个应用程序一次向多行添加#(注释)标记 . 例如,记事本中所选文本的“块注释”右键单击选项 .
9 回答
不要试图理解它,但如果你使用Sublime Text作为你的编辑器,步骤是:
选择块
Mac上为
CMD + /
,Linux和Windows上为CTRL + /
利润
我想其他编辑也有类似的功能 . 你在用哪一个?我很乐意做一些挖掘工作 .
spec仅描述了一种标记注释的方法:
就这样 . 没有块评论 .
An alternative approach:
如果
您的YAML结构具有明确定义的字段供您的应用使用
并且您可以自由添加其他不会弄乱您的应用的字段
然后
Example:
代替
使用
要么
More advantages:
如果注释变得庞大而复杂且具有重复模式,则可以将它们从纯文本块提升为对象
您的应用可能 - 将来 - 阅读或更新这些评论
Emacs有评论-dwim(Do Do I Mean) - 只需选择块并执行:
这是一个切换 - 用它来评论和取消注释块 .
如果您没有安装yaml-mode,则需要告诉Emacs使用哈希字符(#) .
YAML支持内联注释,但不支持块注释 .
从Wikipedia开始:
与JSON的比较,也来自Wikipedia:
在Vim中,您可以执行以下操作之一:
评论所有行:
:%s/^/#
评论专栏10 - 15:
:10,15s/^/#
注释第10行到当前行:
:10,.s/^/#
注释第10行结束:
:10,$s/^/#
或使用视觉块:
通过Ctrl v输入可视块后选择一个多行列 .
按r后跟#以注释掉替换选择的多行块,或按Shift i#Esc在选择前插入注释字符 .
如果您将Eclipse与yedit插件(.yaml文件的编辑器)一起使用,则可以通过以下方式注释掉多行:
选择要评论的行,然后
Ctrl Shift C.
要取消评论,请按照相同的步骤操作 .
对于Windows上的Ruby Mine用户:
在编辑器中打开文件选择块并按Ctrl Forward斜杠,您将选择以#开头的块 .
现在,如果要取消注释已注释的块,请按相同的组合键再次按Ctrl键
在YAML中阻止评论的唯一方法是使用另一个应用程序一次向多行添加#(注释)标记 . 例如,记事本中所选文本的“块注释”右键单击选项 .