<include> (Visual C++)
La balise <include> permet de faire référence à des commentaires situés dans un autre fichier qui décrivent les types et membres dans votre code source.Cette solution remplace celle consistant à placer des commentaires de documentation directement dans votre fichier de code source.Par exemple, vous pouvez utiliser <include> pour insérer les commentaires standard « zones fixes » utilisés dans l'ensemble de votre équipe ou société.
<include file='filename' path='tagpath' />
Paramètres
filename
Nom du fichier contenant la documentation.Le nom du fichier peut être précisé par un chemin.Mettez le nom entre guillemets simples ou doubles.Le compilateur émet un avertissement s'il ne trouve pas filename.tagpath
Une expression XPath valide qui sélectionne le nœud- positionnement souhaité est contenu dans le fichier.name
Dans la balise, spécificateur de nom précédant les commentaires ; name est associé à un id.id
ID de la balise qui précède les commentaires.Mettez le nom entre guillemets simples ou doubles.
Notes
La balise <include> utilise la syntaxe XML XPath.Consultez la documentation de XPath pour les façons de personnaliser l' <include>.
Compilez avec /doc pour traiter les commentaires de documentation et les placer dans un fichier.
Exemple
Cet exemple fait appel à plusieurs fichiers.Le premier fichier, qui utilise <include>, contient les commentaires de documentation suivants :
// 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() {
}
};
Le deuxième fichier, xml_include_tag.doc, contient les commentaires de documentation suivants :
<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>
Sortie du programme
<?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>