<include> tag della documentazione
Il tag <include> consente di fare riferimento ai commenti di un altro file per la descrizione dei tipi e dei membri del codice sorgente, Questo tag è un'alternativa all'inserimento dei commenti della documentazione direttamente nel file del codice sorgente. Ad esempio, è possibile usare <include> per inserire commenti standard "boilerplate" usati in tutto il team o l'azienda.
Sintassi
/// <include file='filename' path='tag-path[@name="ID"' />
Parametri
filename
Nome del file che contiene la documentazione. È possibile qualificare il nome del file con un percorso. Racchiudere il nome tra virgolette singole o doppie. Il compilatore genera un avviso se non trova filename.
tag-path
Espressione XPath valida che seleziona il set di nodi desiderato contenuto nel file.
name
Identificatore del nome contenuto nel tag che precede i commenti. name ha sempre un ID.
ID
ID del tag che precede i commenti. Racchiudere l'ID tra virgolette singole o doppie.
Osservazioni:
Il <include> tag usa la sintassi XPath XML. Per informazioni su come personalizzare tramite <include>, vedere la documentazione di XPath.
Compilare con /doc per elaborare i commenti della documentazione in un file.
Esempio
In questo esempio vengono usati più file. Il primo file, che usa <include>, contiene i commenti della documentazione seguenti:
// 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() {
}
};
Il secondo file, xml_include_tag.doc, contiene i commenti della documentazione seguenti:
<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>
Output di programma
<?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>