Комментарии в xml файле как делать

Комментарии в xml файле как делать

Вот код, который парсит, коменты не берет:
Function GetXmlFromString(s)
Set xmlDoc = CreateObject(«Microsoft.XMLDOM»)
If CaseIgnoreFind(Trim(s), » S_Parse = «» & s
Else
S_Parse = s
End If
xmlDoc.LoadXML (S_Parse) ‘From string
Set GetXmlFromString = xmlDoc
End Function

(12) это что за код? 🙂
что ты хочешь им сделать?
Может этот фрагмент что-то прояснит:
commentItem = xmlDoc.createComment(«Hello World!»);
xmlDoc.documentElement.appendChild(commentItem);

Компьютеры — прекрасное средство для решения проблем, которых до их появления не было.

Зачем комментарии в xml, если можно придумать свой тег для этого?

Вот недавно я начал баловаться с xml, и подумал: «А зачем в xml комментарии если можно придумать свой тег для этого?», и ответ так и не нашёл, может вы поможете?

• Вопрос задан более года назад
• 67 просмотров

1 комментарий

Средний 1 комментарий

можно закомментировать часть DOM после помещения в комментарий сломать DOM что внутри

и ничего за
это не будет:

если вместо комментирования положить в ваш изобретенный тег и фрагмент DOMа внутри тега сломать:

то будет нехорошо всему документу

Решения вопроса 1

зачем придумывать, если уже есть комментарии?

коменты визуально отличаются от тегов, что упрощает чтение глазами.
коменты, в отличие от тега, автоматически пропускаются парсерами.
с коментами даже теоретически не возникнет казуса с дублирующими тегами.

Вставка XML-комментариев для создания документации

Область применения:Visual Studio Visual Studio для Mac Visual Studio Code

Visual Studio может помочь вам документировать элементы кода, такие как классы и методы, автоматически формируя стандартную структуру комментариев для XML-документации. Во время компиляции можно создать XML-файл, содержащий комментарии для документации. Чтобы включить этот параметр, выберите Generate a file containing API documentation (Создать файл, содержащий документацию по API) на вкладке Сборка>Выходные данные в свойствах проекта.

Если вы хотите настроить нестандартное имя и расположение для файла документации, добавьте свойство DocumentationFile в файл .csproj, .vbproj или .fsproj.

Созданный компилятором XML-файл можно распространять вместе со сборкой .NET, чтобы Visual Studio и другие интегрированные среды разработки могли использовать IntelliSense для отображения кратких сведений о типах и элементах. Кроме того, XML-файл можно запускать с помощью таких средств, как DocFX и Sandcastle, и создавать веб-сайты со справочными сведениями по API.

Команда Вставить комментарий, которая автоматически вставляет комментарии XML-документации, доступна в C# и Visual Basic. Однако можно вручную вставить комментарии XML-документации в файлы C++ и по-прежнему создавать файлы XML-документации во время компиляции.

Вставка XML-комментариев для элемента кода

1. Поместите текстовый курсор над элементом, например методом, который нужно задокументировать.
2. Выполните одно из следующих действий.
   • Введите /// в C# или »’ в Visual Basic
   • В меню Правка выберите IntelliSense>Вставить комментарий.
   • Щелкните правой кнопкой мыши или вызовите контекстное меню в редакторе кода или над ним и выберите Фрагмент кода>Вставить комментарий.

Над элементом кода сразу же создается XML-шаблон. Например, при комментировании метода создается элемент , элемент для каждого параметра и элемент для документирования возвращаемого значения.

Введите описание для каждого XML-элемента, чтобы полностью задокументировать элемент кода.

Стили можно использовать в комментариях XML, которые будут отображаться в виде кратких сведений при наведении указателя мыши на элемент. К этим стилям относятся курсив, полужирный шрифт, маркеры и ссылка, доступная для щелчка.

Существует параметр для переключения комментариев XML-документации после ввода /// в C# или »’ Visual Basic. В строке меню выберите Сервис>Параметры, чтобы открыть диалоговое окно Параметры. Затем перейдите к текстовому редактору >C# (или Visual Basic). > В разделе Справка редактора найдите параметр Создавать комментарии XML-документации.

См. также

• Документирование кода с помощью XML-комментариев (руководство по C#)
• Практическое руководство. Создание XML-документации (Visual Basic)
• Комментарии C++
• XML-документация (C++)
• Создание кода

Правила синтаксиса XML

Правила синтаксиса XML крайне просты и логичны. Их легко запомнить и легко использовать.

У XML документа должен быть корневой элемент

XML документ должен содержать один элемент, который будет родительским для всех других элементов. Он называется корневым элементом.

В следующем примере корневым является элемент :

   Tove Jani Напоминание Не забудь обо мне в эти выходные!  

XML пролог

Следующая строка называется XML прологом:

XML пролог необязателен. Но если он есть, то это должна быть первая строка XML документа.

В XML документе могут присутствовать международные символы, вроде русских букв, и чтобы не возникало ошибок необходимо указать кодировку, либо сохранить XML файл в формате UTF-8.

UTF-8 — кодировка XML документов по умолчанию.

UTF-8 также является кодировкой по умолчанию для HTML5, CSS, JavaScript, PHP и SQL.

Все XML элементы должны иметь закрывающий тег

В HTML некоторые элементы могут не иметь закрывающего тега:

 
Это параграф.

В XML нельзя опускать закрывающий тег. Абсолютно все элементы должны закрываться:

 
Это параграф.
 

Возможно, вы заметили из предыдущих примеров, что у XML пролога нет закрывающего тега. Это не ошибка. Дело в том, что декларация (а XML пролог это декларация) не относится к XML документу, поэтому у нее и нет закрывающего тега.

Теги XML регистрозависимы

Теги XML являются регистрозависимыми. Так, тег не то же самое, что тег .

Открывающий и закрывающий теги должны определяться в одном регистре:

 Это неправильно Это правильно 

«Открывающий и закрывающий теги» иногда еще называют «начальный и конечный теги». Используйте то определение, которое вам более симпатично. По сути это одно и то же.

XML элементы должны соблюдать корректную вложенность

В HTML иногда можно наблюдать такую картину:

 Это жирный и курсивный текст 

и иногда это даже работает должным образом.

В XML все элементы обязаны соблюдать корректную вложенность:

 Это жирный и курсивный текст 

Понятие «корректная вложенность» по отношению к приведенным примерам просто означает, что так как элемент открывается внутри элемента , то и закрываться он должен внутри элемента .

Значения XML атрибутов должны заключаться в кавычки

Так же, как и в HTML, у XML элементов могут быть атрибуты в виде пары имя/значение .

В XML значения атрибутов должны заключаться в кавычки.

Посмотрите на следующие два примера XML документа. Первый с ошибкой, второй написан правильно.

  Tove Jani  

  Tove Jani  

Ошибка в первом XML документе заключается в том, что значение атрибута date элемента не заключено в кавычки.

Сущности

Некоторые символы в XML имеют особые значения.

Так, к ошибке приведет следующая строка XML документа:

 если жалование < 1000

Чтобы такая ошибка не возникала, нужно заменить символ «сущность:

 если жалование < 1000 

В XML существует 5 предопределенных сущностей:

Сущность	Символ	Значение
<		меньше, чем
>	>	больше, чем
&	&	амперсанд
'	‘	апостроф
"	«	кавычки

Только символы «<" и "&" строго запрещены в XML. Символ ">» допустим, но лучше его всегда заменять на сущность.

Комментарии в XML

Синтаксис комментариев в XML такой же, как и в HTML.

Использование двух символов тире в середине комментария не допустимо.

Странно, но так можно:

В XML пробелы сохраняются

В HTML несколько последовательных пробельных символов усекаются до одного. В XML документе все пробельные символы сохраняются.

В XML новая строка сохраняется как LF

В приложениях Windows новая строка хранится в следующем виде: символ перевода каретки и символ новой строки (CR+LF).

Unix и Mac OSX используют LF.

Старые Mac системы используют CR.

XML сохраняет новую строку как LF.

Синтаксически верный XML документ

Если XML документ составлен в соответствии с приведенными синтаксическими правилами, то говорят, что это «синтаксически верный» XML документ.