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

<include>(Visual Basic)

  • Статья

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

Ссылается на другой файл, описывающий типы и элементы в исходном коде.

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

Параметры

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

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

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

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

Заметки

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

Тег <include> использует W3C XML Path Language (XPath) Version 1.0 Recommendation. Дополнительные сведения о способах настройки использования <include> доступны на http://www.w3.org/TR/xpath.

Пример

Этот пример использует тег <include> для импорта комментариев документации элемента из файла с именем commentFile.xml.

''' <include file="commentFile.xml" 
''' path="Docs/Members[@name='Open']/*" />
Public Sub Open(ByVal filename As String)
    ' Code goes here.
End Sub
''' <include file="commentFile.xml" 
''' path="Docs/Members[@name='Close']/*" />
Public Sub Close(ByVal filename As String)
    ' Code goes here.
End Sub

Формат commentFile.xml представлен ниже.

<Docs>
<Members name="Open">
<summary>Opens a file.</summary>
<param name="filename">File name to open.</param>
</Members>
<Members name="Close">
<summary>Closes a file.</summary>
<param name="filename">File name to close.</param>
</Members>
</Docs>

См. также

Ссылки

Рекомендуется использовать XML-теги для комментариев документации (Visual Basic)