既然您已經熟悉了YAML的語法和基礎知識,那麼讓我們進一步了解它的細節。在本章中,我們將看到如何在YAML中使用注釋。
YAML支持單行注釋。下面通過一個例子來解釋它的結構;
# this is single line comment.
YAML不支持多行注釋。如果要爲多行提供注釋,可以按照下面的示例−
# this # is a multiple # line comment
Features of Comments
YAML中評論的特點如下所示;
執行期間跳過注釋塊。
注釋有助於添加指定代碼塊的說明。
注釋不能出現在標量內。
YAML不包含任何轉義散列符號(#)的方法,因此在多行字符串中,無法將注釋與原始字符串值分開。
集合中的注釋如下所示;
key: #comment 1 - value line 1 #comment 2 - value line 2 #comment 3 - value line 3
注釋YAML塊的快捷鍵組合是Ctrl+Q。
如果您使用的是Sublime Text editor,注釋塊的步驟如下−
選擇塊。在Linux和Windows上使用「CTRL+/」,在Mac作業系統上使用「CMD+/」。執行塊。
請注意,如果您使用的是Visual Studio代碼編輯器,則同樣的步驟也適用。由於大多數作業系統都支持YAML文件,並且包括開發人員友好的快捷鍵,因此始終建議使用Sublime Text Editor來創建YAML文件。