<include> (Guide de programmation C#)

Article
01/07/2009

Mise à jour : novembre 2007

<include file='filename' path='tagpath[@name="id"]' />

Paramètres

filename
Nom du fichier contenant la documentation. Le nom du fichier peut être précisé par un chemin. Mettez filename entre guillemets simples (' ').
tagpath
Chemin des balises dans filename qui mène à la balise name. Mettez le chemin entre guillemets simples (' ').
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. Placez l'ID entre guillemets doubles (" ").

Notes

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.

La balise <include> utilise la syntaxe XML XPath. Pour en savoir plus sur les différentes façons de personnaliser votre utilisation de <include>, consultez la documentation XPath.

Exemple

Cet exemple fait appel à plusieurs fichiers. Le premier, qui utilise <include>, est indiqué ci-dessous :

// compile with: /doc:DocFileName.xml 

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

/// <include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test2"]/*' />
class Test2
{
    public 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>

<name>xml_include_tag</name>

</assembly>

The summary for this type.

</summary>

</member>

The summary for this other type.

</summary>

</member>

</members>

</doc>

Voir aussi

Concepts

Guide de programmation C#

Référence

Balises recommandées pour commentaires de documentation (Guide de programmation C#)

Partager via