Bagikan melalui

<include> tag dokumentasi

  • Artikel

Tag <include> memungkinkan Anda merujuk ke komentar di file lain yang menjelaskan jenis dan anggota dalam kode sumber Anda. Tag ini adalah alternatif untuk menempatkan komentar dokumentasi langsung di file kode sumber Anda. Misalnya, Anda dapat menggunakan <include> untuk menyisipkan komentar "boilerplate" standar yang digunakan di seluruh tim atau perusahaan Anda.

Sintaks

/// <include file='filename' path='tag-path[@name="ID"' />

Parameter

filename
Nama file yang berisi dokumentasi. Nama file dapat memenuhi syarat dengan jalur. Sertakan nama dalam tanda kutip tunggal atau ganda. Pengkompilasi mengeluarkan peringatan jika tidak menemukan filename.

tag-path
Ekspresi XPath valid yang memilih kumpulan simpul yang diinginkan yang terkandung dalam file.

name
Penentu nama dalam tag yang mendahului komentar; name akan memiliki ID.

ID
ID untuk tag yang mendahului komentar. Sertakan ID dalam tanda kutip tunggal atau ganda.

Keterangan

Tag <include> menggunakan sintaks XML XPath. Lihat dokumentasi XPath untuk cara menyesuaikan menggunakan <include>.

Kompilasi dengan /doc untuk memproses komentar dokumentasi ke file.

Contoh

Contoh ini menggunakan beberapa file. File pertama, yang menggunakan <include>, berisi komentar dokumentasi berikut:

// xml_include_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_include_tag.dll

/// <include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test"]/*' />
public ref class Test {
   void TestMethod() {
   }
};

/// <include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test2"]/*' />
public ref class Test2 {
   void Test() {
   }
};

File kedua, xml_include_tag.doc, berisi komentar dokumentasi berikut:

<MyDocs>

<MyMembers name="test">
<summary>
The summary for this type.
</summary>
</MyMembers>

<MyMembers name="test2">
<summary>
The summary for this other type.
</summary>
</MyMembers>

</MyDocs>

Program Output

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>t2</name>
    </assembly>
    <members>
        <member name="T:Test">
            <summary>
The summary for this type.
</summary>
        </member>
        <member name="T:Test2">
            <summary>
The summary for this other type.
</summary>
        </member>
    </members>
</doc>

Lihat juga

Dokumentasi XML