Поделиться через

<include> (Руководство по программированию на C#)

  • Статья

Обновлен: Ноябрь 2007

<include file='filename' path='tagpath[@name="id"]' />

Параметры

  • filename
    Имя файла, содержащего документацию. Имя файла может быть дополнено путем. Заключите filename в одинарные кавычки (' ').

  • tagpath
    Путь тегов в filename, который приводит к тегу name. Заключите путь в одинарные кавычки (' ').

  • name
    Спецификатор имени в теге, который предшествует комментариям; name будет иметь id.

  • id
    Идентификатор для тега, который предшествует комментариям. Заключите идентификатор в двойные кавычки (" ").

Заметки

Используйте тег <include> для ссылок на комментарии в другом файле, описывающем типы и элементы в исходном коде. Он является альтернативой размещению комментариев документации непосредственно в файле исходного кода.

Тег <include> использует синтаксис XPath XML. Сведения о способах настройки использования тега <include> см. в документации по XPath.

Пример

В данном примере используется несколько файлов. Первый файл, использующий тег <include>, указан ниже.

// compile with: /doc:DocFileName.xml 

/// <include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test"]/*' />
class Test
{
    static void Main()
    {
    }
}

/// <include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test2"]/*' />
class Test2
{
    public void Test()
    {
    }
}

Второй файл — xml_include_tag.doc — содержит следующие комментарии к документации.

<MyDocs>

<MyMembers name="test">
<summary>
The summary for this type.
</summary>
</MyMembers>

<MyMembers name="test2">
<summary>
The summary for this other type.
</summary>
</MyMembers>

</MyDocs>

Выходные данные программы

<?xml version="1.0"?>

<doc>

<assembly>

<name>xml_include_tag</name>

</assembly>

<members>

<member name="T:Test">

<summary>

The summary for this type.

</summary>

</member>

<member name="T:Test2">

<summary>

The summary for this other type.

</summary>

</member>

</members>

</doc>

См. также

Основные понятия

Руководство по программированию в C#

Ссылки

Рекомендуемые теги для комментариев документации (Руководство по программированию в C#)