Форматы данных
Комментарии в XML: синтаксис, правила и примеры
Комментарий XML начинается с <!-- и заканчивается -->. Комментарии документируют файл, но являются разметкой, а не символьными данными, и имеют более строгий синтаксис, чем комментарии во многих языках программирования.
Опубликовано
Синтаксис комментариев XML
Комментарии могут находиться вне другой разметки и, в разрешённых местах, внутри объявления типа документа. Они не являются частью символьных данных элемента.
<!-- Explain why this value is fixed -->
<timeout>30</timeout>Комментарий не может содержать --
XML 1.0 запрещает последовательность из двух дефисов внутри комментария. Грамматика также отклоняет комментарий, закрывающийся тремя дефисами.
Valid: <!-- retry policy: fixed -->
Invalid: <!-- retry -- policy -->
Invalid: <!-- retry policy --->Где могут находиться комментарии
- До или после корневого элемента документа.
- Между дочерними элементами внутри документа.
- Не внутри начального или конечного тега, значения атрибута либо другого комментария.
- Не перед XML-декларацией, которая при наличии должна идти первой.
Что происходит с комментариями при конвертации
XML-процессор может предоставлять комментарии приложению, но приложение не обязано их сохранять. XML-to-JSON отображения для приложений обычно пропускают комментарии, а режим точного сохранения может представить их явно.
Не храните обязательные бизнес-данные только в комментарии, если они должны сохраниться в итоговом JSON.
Проверьте пример
Преобразуйте XML с комментарием
Сравните разметку документа с JSON-отображением для приложений.
<config><!-- seconds --><timeout>30</timeout></config>Ожидаемый результат: Умное отображение сохраняет timeout и пропускает комментарий в данных приложения.
Проверьте поведение парсера
Преобразуйте XML с комментариями
Загрузите XML-документ с комментариями и посмотрите, какие режимы отображения сохраняют или пропускают сведения о комментариях.
Комментирование XML-разметки
Комментарий может временно окружать разметку, только если внутри нет другого комментария и последовательности --. В XML нет синтаксиса вложенных комментариев.