Esempio di documentazione XML

Articolo
09/12/2008

Aggiornamento: novembre 2007

In questo esempio viene illustrato l'utilizzo di XML per documentare il codice. Per ulteriori informazioni, vedere Commenti relativi alla documentazione XML (Guida per programmatori C#).

Per ottenere esempi e istruzioni per la relativa installazione

Effettuare una delle seguenti operazioni:
- Dal menu Guida, scegliere Esempi.
  
  Il file Readme contiene informazioni sugli esempi.
- Visitare il sito Web Visual Studio 2008 Samples (informazioni in lingua inglese). Su tale sito sono disponibili le versioni più recenti degli esempi.
- Individuare gli esempi sul computer in cui è installato Visual Studio. Il percorso di installazione predefinito degli esempi e del file Readme relativo è unità:\Programmi\Microsoft Visual Studio 9.0\Samples\lcid. Per le versioni Express di Visual Studio tutti gli esempi sono disponibili in linea.

Per ulteriori informazioni, vedere Individuazione dei file di esempio.

Nota sulla sicurezza:
In questo esempio di codice viene illustrato un concetto e viene presentato solo il codice rilevante. È possibile che questo esempio non soddisfi i requisiti di sicurezza per un ambiente specifico ed è opportuno non utilizzarlo così come viene riportato. È consigliabile aggiungere codice relativo alla sicurezza e alla gestione degli errori per rendere i progetti più sicuri e potenti. Microsoft fornisce questo esempio di codice "COSÌ COM'È" senza garanzie.

In questo esempio di codice viene illustrato un concetto e viene presentato solo il codice rilevante. È possibile che questo esempio non soddisfi i requisiti di sicurezza per un ambiente specifico ed è opportuno non utilizzarlo così come viene riportato. È consigliabile aggiungere codice relativo alla sicurezza e alla gestione degli errori per rendere i progetti più sicuri e potenti. Microsoft fornisce questo esempio di codice "COSÌ COM'È" senza garanzie.

Per generare l'esempio di documentazione XML all'interno di Visual Studio

In Esplora soluzioni fare clic con il pulsante destro del mouse sul progetto, quindi scegliere Proprietà.
Aprire la cartella Proprietà di configurazione, quindi scegliere Compila.
Impostare la proprietà File di documentazione XML su XMLsample.xml.
Scegliere Genera dal menu Genera.

Il file di output XML sarà generato nella directory di debug.

Per compilare l'esempio XML Documentation da un prompt dei comandi

Per generare la documentazione XML di esempio, digitare quanto segue al prompt dei comandi:
```
csc XMLsample.cs /doc:XMLsample.xml
```
Per visualizzare il file XML generato, digitare il comando seguente:
```
type XMLsample.xml
```

Vedere anche

Attività

Procedura: utilizzare le funzionalità relative alla documentazione XML (Guida per programmatori C#)

Concetti

Esempi di Visual C#

Guida per programmatori C#

Condividi tramite