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文件,幷包含開發人員友好的快捷鍵。

0 條評論,你可以發表評論,我們會進行改進
Comment author placeholder