如何在 YAML 中添加注释

YAML 广泛用于为容器化应用程序编写配置文件。

现在,您出于多种原因想要注释掉代码行,例如解释特定行的用途或忽略导致错误的行。

YAML 只支持单行注释。 您所要做的就是在一行的开头添加#。 你也可以把它放在句子的中间。 # 之后直到行尾的文本将被忽略。

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

您不能像在 C、C++ 和其他语言中那样添加注释块。 但是,使用您选择的文本编辑器,您可以用更少的击键来注释多行。

我将在本快速教程中介绍两者:

  • 注释单行
  • 添加内联评论
  • 注释掉多行

因此,让我们从评论一行开始。

在 YAML 中注释一行

你将不得不使用哈希 # 在 YAML 中添加注释的符号。

作为参考,在这里,我将在文件开头添加注释,还将向您展示如何注释掉单行:

整洁的方式。 正确的?

但是注释掉多行呢? 那么,这就是你如何做的。

在 YAML 中添加内联注释

您还可以在 YAML 中添加“内联评论”。 此方法在代码之后的同一行中添加注释。

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

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

在 C 和许多其他语言中,您可以通过将它们放在 /* 和 */ 之间来注释掉数百行。

YAML 没有块注释功能。 如果您必须注释掉 20 行,则必须在所有这 20 行的开头添加 #。

您可以手动一一完成,或者您可以使用文本编辑器并在更少的击键中将 # 添加到所有这些行。

在这里,我使用的是 nano 编辑器,要注释掉多行,您必须执行三个简单的步骤。

1.使用Alt+A设置标记

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

一旦你按下 Alt + Anano 会表示你在那条线上做了标记。

2.使用箭头键选择行

设置标记后,您可以使用向上或向下箭头键选择多行:

在纳米文本编辑器中选择多行代码

3.使用Esc +3 注释掉选中的行

选择完多行后,您可以使用 Esc + 3 注释掉选定的行:

注释掉 YAML 文件中的多行

4.取消标记

注释掉选定的行后,您将不得不取消设置可以使用的标记 Alt + A:

纳米文本编辑器中的未设置标记

最后,您可以保存更改并退出 nano 文本编辑器。

但是其他文本编辑器呢?

我喜欢 nano,但这对每个人来说都不一样。 好消息是大多数文本编辑器都具有向多行添加注释的功能。

如果您是 VSCode 用户,我们提供了有关如何注释多行(适用于任何编程语言)的详细指南:

发表评论的时间

喜欢在中添加评论 bash 脚本,也无法在此处添加评论块。 但是,我们对此无能为力,不是吗?

由于您正在阅读有关在 YAML 中添加评论的信息,因此我建议您复习一下 YAML 基础知识👇

🗨 既然您知道如何在 YAML 文件中添加评论,那么给这篇文章添加评论并告诉我们它是否有帮助如何?