<include> (Guida per programmatori C#)

Aggiornamento: novembre 2007

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

Parametri

• filename
  Nome del file che contiene la documentazione. È possibile qualificare il nome del file tramite un percorso. Racchiudere filename tra virgolette singole (' ').

• tagpath
  Percorso dei tag di filename che porta al name del tag. Racchiudere il percorso tra virgolette singole (' ').

• 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 doppie (" ").

Note

Il tag <include> consente di fare riferimento ai commenti in un altro file che descrivono i tipi e i membri del codice sorgente, eliminando la necessità di inserire i commenti per la documentazione direttamente nel file del codice sorgente.

Il tag <include> utilizza la sintassi XML XPath. Per informazioni sulla personalizzazione dell'utilizzo di <include>, consultare la documentazione relativa a XPath.

Esempio

In questo esempio vengono presi in considerazione più file. Il primo file, che utilizza <include>, è riportato di seguito.

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

Nel secondo file, xml_include_tag.doc, sono contenuti i seguenti commenti relativi alla documentazione:

<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>xml_include_tag</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>

Vedere anche

Concetti

Guida per programmatori C#

Riferimenti

Tag consigliati per i commenti relativi alla documentazione (Guida per programmatori C#)