<include> (Visual Basic)

  • Artykuł

Odnosi się do innego pliku, który zawiera opis typów i członków w kodzie źródłowym.

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

Parametry

  • filename
    Wymagane.Nazwa pliku zawierającego w dokumentacji.Nazwa pliku może zostać zakwalifikowany ze ścieżką.Należy ująć filename w podwójny cudzysłów ("").

  • tagpath
    Wymagane.Ścieżka znaczniki w filename prowadzi to do znacznika name.Należy ująć ścieżkę w znaki podwójnego cudzysłowu ("").

  • name
    Wymagane.Specyfikator nazwy w tagu, który poprzedza komentarze.Namebędzie id.

  • id
    Wymagane.Identyfikator znacznika, który poprzedza komentarze.Należy ująć identyfikator w znaki pojedynczego cudzysłowu (' ').

Uwagi

Użyj <include> tag, aby odwołać się do uwag w innym pliku, które opisują typy i członków w kodzie źródłowym.Jest to alternatywa dla wprowadzania komentarzy dokumentacji bezpośrednio w pliku kodu źródłowego.

<include> Tag używa zalecenia konsorcjum W3C XML Path Language (XPath) w wersji 1.0.Więcej informacji o sposobach dostosowywania programu <include> wykorzystania jest dostępna pod adresem http://www.w3.org/TR/xpath.

Przykład

W tym przykładzie użyto <include> tag importowanie komentarzy dokumentacji Członkowskie z pliku o nazwie 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

Format commentFile.xml jest w następujący sposób.

<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>

Zobacz też

Informacje

Zalecane tagi XML dla komentarzy dokumentacji (Visual Basic)