Теперь, когда вы знакомы с синтаксисом и основами YAML, давайте углубимся в его детали. В этой главе мы увидим, как использовать комментарии в YAML.
YAML поддерживает однострочные комментарии . Его структура объясняется ниже с помощью примера —
# this is single line comment.
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 — Ctrl + Q.
Если вы используете редактор Sublime Text , шаги для комментирования блока упомянуты ниже —
Выберите блок. Используйте «CTRL + /» в Linux и Windows и «CMD + /» для операционной системы Mac. Выполнить блок.
Обратите внимание, что те же шаги применимы, если вы используете редактор кода Visual Studio . Всегда рекомендуется использовать Sublime Text Editor для создания YAML-файлов, так как он поддерживается большинством операционных систем и содержит удобные сочетания клавиш для разработчиков.