Начать стоит с того, как происходит работа с документами XML. Комментарии в этом файле схожи с комментариями HTML. Обычно их следует добавлять в качестве примечания или строки, чтобы лучше понять цель XML-кодов.
В каждом языке программирования комментарии играют важную роль, поскольку с их помощью возможно давать пояснение к участку кода. Однако следует обратить внимание на то, что встроенный комментарий нужно применять в ограниченных количествах, поскольку иначе будет затруднено чтение кода. И всё же их использование может помочь программисту. Например, когда нужно провести отладку, использовать другие значения программы.
Комментарии позволяют включать связанные ссылки, информацию и термины. Их можно увидеть в исходных кодах. Комментарии возможны в любых местах XML-кода.
У XML - комментария следующая форма, которую называют синтаксисом:
<!--Your comment-->
Соответственно начало комментария обозначено «<! —», конец обозначен «->». Между этими символами вы должны добавить текстовую заметку.
Запрещено добавление одного комментария в другой.
Разберём на примере. Перед вами документ XML.
<?xml version = "1.0" encoding = "UTF-8" ?>
<!--Student test results-->
<my_list>
<studentname>
<name>Anne</name>
<grade>B</grade>
</studentnamet>
</my_list>
<!--Student test results--> в данном случае является комментарием. На его месте может быть любая фраза.
Подытожим. Какие основные правила для вставки в XML файл комментария?
- Возможно добавления комментария даже до объявления XML.
- Комментарий можно добавлять в любом месте документа.
- Комментарий не может существовать в пределе атрибута со значением.
- Комментарий нельзя добавлять внутри другого.
