<include> (Visual Basic)

  • Статья

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

Синтаксис

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

Параметры

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

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

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

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

Замечания

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

Тег <include> использует рекомендацию по языку XML-пути W3C (XPath) версии 1.0. Дополнительные сведения о способах настройки <include> использования см. в статье https://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>

См. также