YAML и конфигурация

Комментарии в YAML: синтаксис, правила оформления и экранирование

В YAML комментарии начинаются с символа # вне кавычек и продолжаются до конца строки.

Опубликовано 11 августа 2026 г.

Разбор YAML с комментариями

Четыре значения символа # в одном примере

Пояснения показывают границы синтаксиса парсера; цвет служит лишь визуальной подсказкой.

# полнострочный комментарий
service:
  port: 8080 # инлайн-комментарий
  tag: "#release"
  message: |
    # это содержимое скаляра

Полнострочный комментарийПарсер полностью игнорирует всю строку.
Инлайн-комментарийВсе после значения игнорируется.
Литерал в кавычках#release остается частью строки данных.
Содержимое блочного скаляраСимвол # с отступом принадлежит значению message.

Распарсенные данные

Из этих четырех случаев символ # в кавычках и внутри блочного скаляра является данными. Полнострочный и инлайн # являются комментариями.

Частая ошибка

Комментарий, а не данные

tag: #release

Текстовые данные

tag: "#release"

Редактирование YAML с комментариями

Комментарии поясняют настройку, не становясь частью её значения.

# Production settings
port: 8080 # Public HTTP port
label: "build #42"
message: |
  # This line is scalar content

Ожидаемый результат: Корректный YAML; символы # в кавычках и блочном значении остаются данными.

Проверьте конфигурацию

Проверьте синтаксис ваших YAML файлов в онлайн-форматтере с сохранением комментариев.