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程式碼編輯器,則適用相同的步驟。 始終建議使用Sublime Text Editor建立大多數作業系統支援的YAML檔案,並包含開發人員友好的快捷鍵。