<include> (Visual Basic)
Kaynak kodunuzda türleri ve üyeleri açıklayan başka bir dosyaya başvurur.
Sözdizimi
<include file="filename" path="tagpath[@name='id']" />
Parametreler
filename
Gerekli. Belgeleri içeren dosyanın adı. Dosya adı bir yol ile nitelenebilir. filename Çift tırnak işareti (" ") içine alın.
tagpath
Gerekli. içindeki filename etiketlerin yolu etiketine nameyol açar. Yolu çift tırnak işareti (" ") içine alın.
name
Gerekli. Açıklamaların önündeki etiketteki ad tanımlayıcısı. Name bir idolacaktır.
id
Gerekli. Açıklamaların önündeki etiketin kimliği. Kimliği tek tırnak içine alın (' ').
Açıklamalar
<include> Kaynak kodunuzdaki türleri ve üyeleri açıklayan başka bir dosyadaki açıklamalara başvurmak için etiketini kullanın. Bu, belge açıklamalarını doğrudan kaynak kod dosyanıza yerleştirmenin bir alternatifidir.
<include> etiketi W3C XML Yol Dili (XPath) Sürüm 1.0 Önerisi'ni kullanır. Kullanımınızı <include> özelleştirme yolları hakkında daha fazla bilgi için bkz https://www.w3.org/TR/xpath. .
Örnek
Bu örnekte, adlı commentFile.xmlbir dosyadan üye belgeleri açıklamalarını içeri aktarmak için etiketi kullanılır<include>.
''' <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
biçimi commentFile.xml aşağıdaki gibidir.
<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>
