YAML注釋


既然對YAML的語法和基礎知識感到滿意,那么進一步了解它的細節。在本章中,將了解如何在YAML中使用注釋。

YAML支持單行注釋。 下面借助一個例子來解釋其結構 -

# this is single line comment. 
YAML

YAML不支持多行注釋。 如果要為多行提供注釋,可以執行此操作,如下例所示 -

# this # is a multiple # line comment 
YAML

注釋的特點

YAML中評論的特征如下 -

  • 執行期間會跳過注釋的塊。
  • 注釋有助於添加指定代碼塊的描述。
  • 注釋不得出現在標量內。

YAML不包含任何方法來逃避哈希符號(#),因此在多行字符串中,因此無法將注釋與原始字符串值分開。

集合中的注釋如下所示 -

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

用於注釋YAML塊的快捷鍵組合是Ctrl + Q,如果使用的是Sublime Text編輯器,則會在下面提到注釋該塊的步驟 -
選擇塊,在Linux和Windows上使用CTRL + /,在Mac操作系統上使用CMD + /

請注意,如果使用的是Visual Studio代碼編輯器,則適用相同的步驟。 始終建議使用Sublime Text Editor創建大多數操作系統支持的YAML文件,並包含開發人員友好的快捷鍵。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM