怎样在 YAML 中添加注释

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

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

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

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

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

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

在 YAML 中注释单行

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

图片

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

foo: barwindows: discard # Inline comment linux:debian: ubuntuarch: 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,也是可以的,其操作大同小异。大多数文本编辑器都具有多行注释的功能。

责任编辑:庞桂玉 来源: TIAP
相关推荐

2013-04-01 15:15:35

Eclipse自动添加Android开发

2010-09-07 14:22:41

SQL语句

2011-08-01 15:20:51

SQL Server索引

2018-04-08 11:10:45

GitLinux开源

2020-07-01 16:45:13

matplotlib内嵌图Python

2011-06-14 17:51:47

QListview Qt MVC

2011-01-19 12:27:42

Thunderbird备份

2010-07-09 13:36:11

SQL Server数

2019-09-24 19:00:41

Linuxrm命令unlink命令

2020-07-13 08:18:58

跨库查询MySQL数据库

2009-07-06 15:19:13

webwork ser

2011-08-02 11:07:00

2022-12-14 08:42:46

IDEAIDEA插件

2011-04-07 09:33:22

2015-08-06 13:44:21

swiftcocoapods

2022-11-03 10:36:30

Linux隐藏文件

2010-09-13 10:00:51

CSS注释

2017-08-17 14:38:39

JavaAbstract抽象

2014-07-31 09:44:43

Linuxcp命令合并目录树

2022-11-11 14:55:14

Linuxcron
点赞
收藏

51CTO技术栈公众号