YAML - 註釋



現在您已經熟悉了 YAML 的語法和基礎知識,讓我們進一步深入瞭解其細節。本章將介紹如何在 YAML 中使用註釋。

YAML 支援單行註釋。下面透過示例解釋其結構:

# this is single line comment.

YAML 不支援多行註釋。如果您想為多行提供註釋,可以按照以下示例所示進行:

# this
# is a multiple
# line comment

註釋的功能

YAML 中註釋的功能如下:

  • 註釋塊在執行期間會被跳過。

  • 註釋有助於為指定的程式碼塊新增描述。

  • 註釋不能出現在標量內部。

  • YAML 沒有提供轉義井號 (#) 的方法,因此在多行字串中無法將註釋與原始字串值分開。

集合中的註釋如下所示:

key: #comment 1
   - value line 1
   #comment 2
   - value line 2
   #comment 3
   - value line 3

YAML 塊註釋的快捷鍵組合是 Ctrl+Q

如果您使用的是 Sublime Text 編輯器,則註釋塊的步驟如下:

選擇塊。在 Linux 和 Windows 系統上使用“CTRL + /”,在 Mac 作業系統上使用“CMD+/”。執行塊。

請注意,如果您使用的是 Visual Studio Code 編輯器,則步驟相同。始終建議使用 Sublime Text 編輯器建立 YAML 檔案,因為它受大多數作業系統支援,幷包含對開發人員友好的快捷鍵。

廣告