Xml комментарии: XML — Комментарии — CoderLessons.com

Содержание

Комментарии по работе с xml-отчётами — Московская Биржа

Для использования xsd-схем и xslt-стилей необходимо, чтобы XSLT-стили для всех отчётов располагались в папке C:\MICEX\XSLT, а XSD-схемы для всех отчетов в папке C:\MICEX\XSD.

При просмотре отчётов посредством Internet Explorer будут использоваться стили из папки C:\MICEX\XSLT.

При открытии отчётов из MS Excel помимо указанной директории, программа предложит использовать стили напрямую с сайта Биржи. В случае, если компьютер имеет доступ в Интернет, то при открытии отчета можно выбрать стиль находящийся на сайте Биржи.

В целях безопасности ОС Windows может заблокировать загруженные из сети общего доступа xml- и xslt-файлы. Если это произошло, то откройте свойства файла из Проводника и нажмите кнопку «Разблокировать».

Просмотреть и распечатать отчёт небольшого размера (см. примечания ниже) можно в Microsoft Internet Explorer. Для этого, в типичных конфигурациях достаточно дважды щёлкнуть файл с отчётом в Проводнике. Если же xml-файлы были ассоциированы с другим приложением, выберите Internet Explorer из пункта «Открыть с помощью» контекстного меню файла в Проводнике.

При открытии отчёта из MS Excel будет предложено указать действие при импорте XML – следует выбрать пункт «открыть файл, применив следующую таблицу стилей:» и убедиться что указан требуемый xslt-стиль. Чтобы подготовить отчёт к компактной печати, выберите команду «Параметры страницы» в меню «Файл» и укажите ориентацию – альбомная и масштаб – «разместить не более чем на 1 стр. в ширину и [пустое поле] стр. в высоту». Также можно уменьшить поля, чтобы программа увеличила размер шрифта при масштабировании; для этого: выберите команду «Предварительный просмотр» в меню «Файл», нажмите кнопку «Поля» и уменьшите поля, перетягивая их мышью.

Примечание про открытие отчётов большого размера

При открытии XML-файлов в Internet Explorer версии ниже 7 возможно неточное отображение форматирования столбцов отчетов (выход столбцов за границу печати, некорректный подбор ширины столбцов). Рекомендуется использовать Internet Explorer 7 или 8 для небольших отчетов или MS Excel 2003 для больших (количество записей меньше 65536) или MS Excel 2007 для очень больших (количество записей больше 65536) файлов.

При открытии XML-файлов в Internet Explorer 7 или 8 возникают проблемы с печатью больших отчетов. Проявляется если размер XML-файла равен 8–9 Мб или выше. Эти файлы открываются в IE, но при попытке их распечатать или показать окно предварительного просмотра IE выдает сообщение об ошибке. Рекомендуется использовать MS Excel 2003 для больших (количество записей меньше 65536) или MS Excel 2007 для очень больших (количество записей больше 65536) файлов.

При открытии XML-файлов в MS Excel 2003 или 2007 возникают проблемы с открытием очень больших отчетов. Проявляется если размер XML-файла равен 30–40 Мб или выше. При открытии таких файлов в MS Excel показывается пустая таблица. Рекомендуется для открытия таких файлов предварительно преобразовать их в формат html, используя программу msxsl. exe. Формат командной строки для преобразования отчета в html:
msxsl.exe файл_отчета.xml имя_стиля.xslt –o выходной_файл.html

После этого полученный html файл открыть в MS Excel 2003 (если количество записей меньше 65536) или MS Excel 2007 (если количество записей больше 65536).

c++ — XML документация с++ в Visual Studio

Задать вопрос

Вопрос задан
5 лет 8 месяцев назад

Изменён
2 года 1 месяц назад

Просмотрен
293 раза

Недавно узнал, что /// в Visual Studio используется для создания Xml документации. Также выяснил можно просматривать описание функций с помощью тега <summary>.

Вопрос. Работают ли теги <returns> и <param name="_name_">? Потому что при добавлении их в код, описание не меняется.

Пример кода:

/// <summary>
/// Заполняет массива до конца другой частью массива
/// </summary>
/// <param name="arr">массив требующий заполнения</param>
/// <param name="fullArr">массив, который заполняет arr</param>
/// <param name="startPos">с какой позиции заполнять</param>
/// <returns>заполненный массив</returns>
dynCharArr fillEndOfArr(dynCharArr arr, dynCharArr fullArr, int startPos)
{
    for (int i = startPos; i < fullArr.len; ++i)
       arr.arr[startPos + i] = fullArr.arr[i];
    return arr;
}

Что отображается в Visual Studio

UPD
Заметил ещё такую проблему как полное отсутствие описания в окне Object Browser.

c++
xml
visual-studio-2015
документация

Судя по всему это баг старых версий VS. В Visual Studio 2019 (версия 16.8.3) проблема решена и комментарии к коду отображаются корректно.

Вот как это выглядит сейчас

Зарегистрируйтесь или войдите

Регистрация через Google

Регистрация через Facebook

Регистрация через почту

Отправить без регистрации

Почта

Необходима, но никому не показывается

Отправить без регистрации

Почта

Необходима, но никому не показывается

By clicking “Отправить ответ”, you agree to our terms of service and acknowledge that you have read and understand our privacy policy and code of conduct.

|
что здесь может быть кроме ‘>’?

Похоже, XML не любит «—» внутри комментариев. Я где-то читал, что ‘—‘ переключает некоторые режимы внутри вещь, но (четное число -- s) тоже кажется недействительным. Если это какая-то историческая особенность, что в ней «за»? («против» — невозможность иметь -- в комментариях).

В чем причина усложнения обработки комментария, когда не ставится просто ‘—>’ в конце комментария и разрешается ‘—‘ внутри?

xml
комментарии

Может кому пригодится. У меня была проблема, я хотел закомментировать параметр командной строки в XML, который начинается с —:

так естественно нормальный способ как это

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

Итак, в моем случае строка

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

Конечно, это выглядит немного уродливо, но если кто-то хочет сохранить строку с — как комментарий в своем XML — я думаю, что это все же лучше, чем ничего.

Из стандартного документа:

http://www.w3.org/TR/REC-xml/#sec-comments

[Определение: Комментарии могут появляться в любом месте документа за пределами других
разметка; кроме того, они могут появляться внутри типа документа
объявление в местах, разрешенных грамматикой. Они не являются частью
характерные данные документа; процессор XML может, но не обязательно, сделать это
возможно для приложения, чтобы получить текст комментариев. Для
совместимости строка » — » (двойной дефис) не должна встречаться внутри
комментарии.] Ссылки на объекты параметров не должны распознаваться в
Комментарии.

Это одно из тех дурацких правил, которые есть в XML, потому что оно было в SGML, и люди не хотели нарушать совместимость. Можно только догадываться, почему это в SGML: вероятно, потому, что он сохранил три строки кода в исходном синтаксическом анализаторе.

-- не допускается для совместимости с SGML. От На SGML и HTML:

Не допускается пробел между объявлением разметки open
разделитель (««). Распространенной ошибкой является включение
строка дефисов («—«) внутри комментария. Авторам следует избегать
размещение двух или более соседних дефисов внутри комментариев.

Итак, в SGML и > открывать и закрывать «объявления разметки» и -- открывает и закрывает комментарии.

Эта проблема рано или поздно коснется всех, кто любит использовать комментарии в XML для отключения ненужного контента. У меня были серьезные проблемы в течение нескольких дней с невозможностью загрузки конфигураций контекста Spring без какого-либо подробного объяснения, почему. Проблема была в привычке комментировать блоки контента вот так:

 <значение>ABC1

<значение>ABC3

закомментировано, его нужно изменить на это:

Дефисы в закомментированном блоке вместо того, чтобы игнорироваться, мешали синтаксическому анализу всего файла, где бы они ни находились.

`Зарегистрируйтесь или войдите в систему`

Зарегистрируйтесь с помощью Google

Зарегистрироваться через Facebook

Зарегистрируйтесь, используя электронную почту и пароль

`Опубликовать как гость`

Электронная почта

Требуется, но никогда не отображается

`Опубликовать как гость`

Электронная почта

Требуется, но не отображается

Нажимая «Опубликовать свой ответ», вы соглашаетесь с нашими условиями обслуживания и подтверждаете, что прочитали и поняли нашу политику конфиденциальности и кодекс поведения.

`Какая польза от XML-комментариев в C#`

спросил 9 лет, 5 месяцев назад

Изменено 2 года, 9 месяцев назад

Просмотрено 9к раз

Какая польза от XML-комментариев в C#, кроме сигнальной строки и многострочных комментариев.

 i. Однострочный
Например:
//Это однострочный комментарий
II. Несколько строк (/* */)
Например:
 /*Это многострочный комментарий
Мы в очереди 2
Последняя строка комментария*/
III. XML-комментарии (///).
Например:
/// краткое содержание;
/// Установить сообщение об ошибке для многоязычного языка.
/// краткое содержание

1

Из комментариев XML-документации (Руководство по программированию на C#):

При компиляции с параметром /doc компилятор будет искать все теги XML в исходном коде и создать файл документации XML.

Также XML-комментарии, используемые Visual Studio для IntelliSense:

 /// 
/// Этот класс выполняет важную функцию.
/// 
открытый класс MyClass{}

Дает вам приятные подсказки, когда вы печатаете код или наводите курсор на элемент с комментариями xml:

ПРИМЕЧАНИЕ: Обычно вы должны добавлять комментарии xml только к общедоступным типам или элементам. Если член внутренний или частный, то это хорошо, но не обязательно. Существует хороший инструмент GhostDoc (доступный как расширение для Visual Studio), который может генерировать XML-комментарии из типа или имени члена. Неплохо проверить, правильное ли у вас имя — если сгенерированный комментарий непонятен, то вам следует улучшить имя участника.

Я также предлагаю использовать как можно меньше простых (не XML) комментариев. Потому что комментарий — это форма дублирования кода — он дублирует информацию, которая уже есть в вашем коде. А вот и две проблемы:

Ваш код недостаточно ясен и его следует улучшить (переименовать, извлечь классы или члены) вместо добавления комментариев
При изменении кода комментарии часто остаются без изменений (программисты ленивы). Поэтому со временем комментарии устаревают и сбивают с толку.

Хорошие комментарии должны описывать почему вы пишете код, а не дублируете что делает код .

XML-комментарии, начинающиеся с ///, будут обнаружены IntelliSense и показаны во всплывающем окне при просмотре из другого места. Существует страница MSDN, объясняющая, как это работает.

Их также подберут многочисленные инструменты для создания файлов документации и т. д.

Из MSDN:

При компиляции с параметром /doc компилятор будет искать все теги XML в исходном коде и создать файл документации XML. Чтобы создать окончательную документацию на основе сгенерированного компилятором файл, вы можете создать собственный инструмент или использовать такой инструмент, как Sandcastle.

http://msdn.microsoft.com/en-us/library/b2s063f7.aspx

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

Компилятор (необязательно) извлекает все эти комментарии и помещает их в отдельный XML-файл рядом с вашей сборкой; это можно разобрать.

Идея состояла в том, чтобы иметь что-то вроде JavaDoc. К сожалению, Microsoft не смогла предоставить для этого общепринятый зрелый инструмент.

Когда вы создаете сборку Dll, комментарии Xml предоставляют пользователю dll некоторую информацию о функции или чем-то еще.

Код на всех языках обычно допускает специальные комментарии. Затем эти комментарии могут быть проанализированы процессом, который создает автоматическую документацию кода. Многие библиотеки документированы таким образом.

В C# эти инструменты предоставляются Microsoft, и вы используете XML-комментарии, чтобы объявить, что комментарий должен быть получен в процессе документирования, если он у вас настроен. Комментарии также подхватываются автозаполнением.

См. также doxygen, JavaDoc для реализации для других языков. См. соответствующий вопрос Хорошие альтернативы Sandcastle для создания документации в стиле MSDN

`Зарегистрируйтесь или войдите в систему`

Зарегистрируйтесь с помощью Google

Зарегистрироваться через Facebook

Зарегистрируйтесь, используя электронную почту и пароль

`Опубликовать как гость`

Электронная почта

Требуется, но никогда не отображается

`Опубликовать как гость`

Электронная почта

Требуется, но не отображается