怎样在YAML中添加注释

描述

AML 广泛用于为容器化应用程序编写配置文件。 解释特定行或者忽略错误行,都需要用到注释。

YAML 仅支持单行注释,即在注释文本前使用 #,# 后面的字符均为注释的内容。

# This is a single line comment
foo: bar # This is an inline comment

不能像在 C 或者 C++ 那样使用注释块。 然而,在某些文本编辑器中,可以使用快捷键注释掉多行。

我们先来看一下单行注释。

在 YAML 中注释单行

在 YAML 中添加单行注释,使用井号 #。 看下面的例子:

代码

注释不一定放在一行的开头,在中间也是可以的,需要注意的是,井号 # 往后的部分,都会被标记为注释:

foo: bar
     windows: discard # Inline comment 
     linux:
       debian: ubuntu
       arch: manjaro

YAML 中的多行注释(使用 nano)

在 C 和许多其他语言中,可以使用 /* */ 来注释掉整块代码。 但是在 YAML 中并没有这样的功能。 如果你要注释掉 20 行代码,那需要在这 20 行代码的开头都添加 # 。

添加多行注释,可以手动一个一个的添加 #,也可以使用专门的文本编辑器,使用快捷键来将 # 添加到需要注释的行。

作为演示,我们使用 nano 编辑器。 遵循 4 个简单的步骤就可以注释多行。

1)使用 Alt + A 设置标记

要在nano文本编辑器中选择行,首先,您必须设置一个标记,指示要开始选择的位置:

代码

一旦按下 Alt+A,nano 将指示你在该行上做了标记。

2)使用上下箭头按键选择要注释的行

做完标记后,可以使用向上或向下的箭头按键来选择多行:

代码

3)使用 Esc + 3 注释所选行

选择好需要注释的行后,按键 Esc + 3 将所选行注释掉:

代码

4)取消标记

注释掉所选行后,还需要取消设置的标记,依然使用 Alt + A 组合键。

代码

最后,可根据具体任务保存更改(或者保存后退出 nano 文本编辑器)。

如果你使用的编辑器不是 nano,也是可以的,其操作大同小异。 大多数文本编辑器都具有多行注释的功能。

打开APP阅读更多精彩内容
声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉

全部0条评论

快来发表一下你的评论吧 !

×
20
完善资料,
赚取积分