<sertakan> (Visual Basic)

Merujuk ke file lain yang menjelaskan jenis dan anggota dalam kode sumber Anda.

Sintaksis

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

Parameter-parameternya

filename
Dibutuhkan. Nama file yang berisi dokumentasi. Nama file dapat memenuhi syarat dengan jalur. Sertakan filename dalam tanda kutip ganda (" ").

tagpath
Dibutuhkan. Jalur tag dalam filename yang mengarah ke tag name. Sertakan jalur dalam tanda kutip ganda (" ").

name
Dibutuhkan. Penentu nama dalam tag yang mendahului komentar. Name akan memiliki id.

id
Dibutuhkan. ID untuk tag yang mendahului komentar. Sertakan ID dalam tanda kutip tunggal (' ').

Komentar

<include> Gunakan tag untuk merujuk ke komentar di file lain yang menjelaskan jenis dan anggota dalam kode sumber Anda. Ini adalah alternatif untuk menempatkan komentar dokumentasi langsung dalam file kode sumber Anda.

Tag <include> menggunakan Rekomendasi W3C XML Path Language (XPath) Versi 1.0. Untuk informasi selengkapnya tentang cara menyesuaikan penggunaan Anda <include> , lihat https://www.w3.org/TR/xpath.

Contoh

Contoh ini menggunakan <include> tag untuk mengimpor komentar dokumentasi anggota dari file yang disebut 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

Formatnya commentFile.xml adalah sebagai berikut.

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

Lihat juga

• Tag Komentar XML