Commenti relativi alla documentazione XML (Guida per programmatori C#)
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. Di seguito è riportato un 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. Per creare la documentazione finale basata sul file generato dal compilatore, è possibile creare uno strumento personalizzato o utilizzare uno strumento come Sandcastle.
Nota
I commenti XML relativi alla documentazione non sono metadati, ovvero non vengono inclusi nell'assembly compilato e pertanto non sono accessibili mediante reflection.
Argomenti della sezione
Sezioni correlate
Per ulteriori informazioni, vedere:
Specifiche del linguaggio C#
Per ulteriori informazioni, vedere la Specifiche del linguaggio C#. La specifica del linguaggio è la fonte ufficiale per la sintassi e l'utilizzo di C#.