Commenti relativi alla documentazione XML (Guida per programmatori C#)
Aggiornamento: novembre 2007
In Visual C# è possibile creare documentazione per il codice includendo tag XML in speciali campi di commento del codice sorgente subito prima del blocco di codice cui fanno riferimento. Esempio:
/// <summary>
/// This class performs an important function.
/// </summary>
public class MyClass{}
Quando si esegue la compilazione con /doc, il compilatore cerca tutti i tag XML presenti nel codice sorgente e crea un file di documentazione in formato XML.
Nota: |
---|
I commenti XML relativi alla documentazione non sono metadati, ovvero non vengono inclusi nell'assembly compilato e pertanto non sono accessibili mediante reflection. |
In questa sezione
Sezioni correlate
Per ulteriori informazioni, vedere:
Specifiche del linguaggio C#
Per ulteriori informazioni, vedere le sezioni riportate di seguito in Specifiche del linguaggio C#:
- Appendice A Commenti relativi alla documentazione