Yurijnd.com
Четверг, 06.02.2025, 20:59
Меню сайта

Вход на сайт

Поиск

Друзья сайта
  • Официальный блог
  • Сообщество uCoz
  • FAQ по системе
  • Инструкции для uCoz

  • Статистика

    Онлайн всего: 1
    Гостей: 1
    Пользователей: 0

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

    Visual Studio 2013
     

    В Visual C# можно создавать документацию для кода путем включения XML-элементов в специальные поля комментариев (начинающиеся с трех символов косой черты) в исходном коде непосредственно перед блоком кода, к которому относятся комментарии. Например:

     
     
    /// <summary>
    /// This class performs an important function.
    /// </summary>
    public class MyClass{}
    

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

    Для ссылки на XML-элементы (например, если функция обрабатывает определенные XML-элементы, которые требуется включить в комментарии XML-документации) можно использовать стандартный механизм заключения в скобки (&lt; и &gt;). Для ссылки на универсальные идентификаторы в элементах ссылок кода (cref) можно использовать escape-символы (например, cref="List&lt;T>") или фигурные скобки (cref="List{T}"). В особом случае компилятор анализирует фигурные скобки, как угловые, чтобы при ссылке на универсальные идентификаторы сделать комментарий документации менее громоздким.

    ПримечаниеПримечание

    Комментарии XML-документации не являются метаданными. Они не включаются в скомпилированную сборку, и поэтому не доступны посредством отражения.

    Связанные разделы

     

    Дополнительные сведения см. в следующем разделе:

    Спецификация языка C#

     

    Дополнительные сведения см. в Спецификация языка C#. Спецификация языка является предписывающим источником информации о синтаксисе и использовании языка C#.

     
    Copyright MyCorp © 2025
    Сделать бесплатный сайт с uCoz