Комментарии YAML
Комментарии используются для предотвращения выполнения операторов. Комментарии игнорируются, пока компилятор выполняет код. Комментарии удобны для пользователя, поскольку пользователь может получить объяснения кода с помощью комментариев.
Поскольку вас устраивает структура предложений и основы YAML, давайте продолжим его детали. В этой части мы узнаем, как использовать комментарий в YAML. Комментарии используются для отображения значимого сообщения о жизни кода.
Есть два вида комментариев.
- Встроенный или однострочный комментарий
- Комментарий на уровне блока
YAML поддерживает языковую структуру для встроенных примечаний, но не для блочного уровня. Комментарий
Встроенный комментарий: встроенные комментарии - это примечания, объявленные в строке кода, изображение хэштега используется в начале строки, чтобы сообщить процессору, что это комментарий.
Пример:
# примечания Модель пунктуации в документе YAML или #### #### модель комментариев
Они просто определяются как однострочные комментарии. Каждая строка комментария начинается с изображения хэштега и свободного места, за которым следует изображение. Каждая строка заканчивается новым разрывом строки.
Комментарий на уровне блока: Квадратные комментарии предназначены для обозначения различных строк. YAML, естественно, не помогает для блочного комментария, вы можете использовать множество встроенных комментариев.
# Модель комментариев на уровне блока # Строка комментария 1 # Строка комментария 2 # Строка комментария 3
Важные примечания к комментарию в YAML: комментарии не принимаются во внимание обработчиком yaml. Полезно сообщать о строке кода, упрощает жизнь дизайнеров, помогает упростить выполнение заказов с помощью различных IDE.
YAML поддерживает однострочный комментарий. Его структура поясняется ниже с помощью модели -
# Это однострочный комментарий.
Основные моменты комментариев: основные моменты комментариев в YAML приведены ниже -
- Прокомментированный блок пропускается во время выполнения кода.
- Комментарии помогают добавить изображение для определенного блока кода.
- Комментарии не должны отображаться внутри скаляров.
YAML исключает любой подход, позволяющий уйти от хеш-изображения (#), поэтому внутри многострочной строки маловероятно изолировать комментарий от грубой оценки строки.
Пример:
# комментарий 1 - Строка значения 1 # комментарий 2 - строка значения 2 # комментарий 3 - строка значения 3
Альтернативное сочетание клавиш для комментирования блоков YAML - Ctrl + Q.
Примечание: аналогичные достижения подходят на всякий случай. Постоянно предписывается использовать процессор Superb Word для создания документов YAML, поскольку он поддерживается большинством рабочих фреймворков и включает в себя удобные для соседей ключи маршрутов.