<include> (Visual Basic)

Odwołuje się do innego pliku, który opisuje typy i elementy członkowskie w kodzie źródłowym.

Składnia

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

Parametry

filename
To jest wymagane. Nazwa pliku zawierającego dokumentację. Nazwę pliku można zakwalifikować za pomocą ścieżki. Ujęć filename w znaki podwójnego cudzysłowu (" ").

tagpath
To jest wymagane. Ścieżka tagów w pliku filename , która prowadzi do tagu name. Ująć ścieżkę w podwójny cudzysłów (" ").

name
To jest wymagane. Specyfikator nazwy w tagu poprzedzającym komentarze. Name element będzie miał element id.

id
To jest wymagane. Identyfikator tagu, który poprzedza komentarze. Ujęć identyfikator w pojedynczy cudzysłów (' ').

Uwagi

Użyj tagu <include> , aby odwołać się do komentarzy w innym pliku, który opisuje typy i elementy członkowskie w kodzie źródłowym. Jest to alternatywa dla umieszczania komentarzy dokumentacji bezpośrednio w pliku kodu źródłowego.

Tag <include> używa rekomendacji języka W3C XML Path Language (XPath) w wersji 1.0. Aby uzyskać więcej informacji na temat sposobów dostosowywania <include> użycia, zobacz https://www.w3.org/TR/xpath.

Przykład

W tym przykładzie użyto tagu <include> do zaimportowania komentarzy dokumentacji składowych 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 obiektu commentFile.xml jest następujący.

<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 także

• Tagi komentarzy XML