<include> belge etiketi

etiketi, <include> kaynak kodunuzdaki türleri ve üyeleri açıklayan başka bir dosyadaki açıklamalara başvurmanızı sağlar. Bu etiket, belge açıklamalarını doğrudan kaynak kod dosyanıza yerleştirmeye alternatiftir. Örneğin, ekibiniz veya şirketiniz genelinde kullanılan standart "ortak" açıklamalar eklemek için kullanabilirsiniz <include> .

Sözdizimi

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

Parametreler

filename
Belgeleri içeren dosyanın adı. Dosya adı bir yol ile nitelenebilir. Adı tek veya çift tırnak içine alın. Derleyici, bulamazsa filenamebir uyarı oluşturur.

tag-path
Dosyada bulunan istenen düğüm kümesini seçen geçerli bir XPath ifadesi.

name
Açıklamaların önündeki etiketteki ad tanımlayıcısı; name bir IDolacaktır.

ID
Açıklamaların önündeki etiketin kimliği. Kimliği tek veya çift tırnak içine alın.

Açıklamalar

<include> etiketi XML XPath söz dizimini kullanır. kullanarak <include>özelleştirmenin yolları için XPath belgelerine bakın.

Bir dosyaya belge açıklamalarını işlemek için ile derleyin /doc .

Örnek

Bu örnekte birden çok dosya kullanılır. kullanan <include>ilk dosya aşağıdaki belge açıklamalarını içerir:

// 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() {
   }
};

İkinci dosya olan xml_include_tag.doc, aşağıdaki belge açıklamalarını içerir:

<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 Çıktısı

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

Ayrıca bkz.

XML belgeleri