YAML 注釋

2022-12-06 17:29 更新

既然對YAML的語法和基礎(chǔ)知識感到滿意,那么進(jìn)一步了解它的細(xì)節(jié)。在本章中,將了解如何在YAML中使用注釋。

YAML支持單行注釋。 下面借助一個例子來解釋其結(jié)構(gòu)

# this is single line comment.

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

# this
# is a multiple
# line comment

注釋的特點(diǎn)

YAML中評論的特征如下

  • 執(zhí)行期間會跳過注釋的塊。
  • 注釋有助于添加指定代碼塊的描述。
  • 注釋不得出現(xiàn)在標(biāo)量內(nèi)。

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操作系統(tǒng)上使用CMD + /。

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


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號