怎樣在YAML中添加注釋

AML 廣泛用于為容器化應用程序編寫配置文件。 解釋特定行或者忽略錯誤行，都需要用到注釋。

YAML 僅支持單行注釋，即在注釋文本前使用 #，# 后面的字符均為注釋的內(nèi)容。

# 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 組合鍵。

最后，可根據(jù)具體任務保存更改（或者保存后退出 nano 文本編輯器）。

如果你使用的編輯器不是 nano，也是可以的，其操作大同小異。 大多數(shù)文本編輯器都具有多行注釋的功能。