Commenti relativi alla documentazione XML
Per visualizzare l'articolo in inglese, selezionare la casella di controllo Inglese. È possibile anche visualizzare il testo inglese in una finestra popup posizionando il puntatore del mouse sopra il testo.
Traduzione
Inglese

Commenti relativi alla documentazione XML (Guida per programmatori C#)

 

Pubblicato: aprile 2016

In Visual C# è possibile creare la documentazione relativa al codice includendo elementi XML in campi di commento speciali (indicati da barre triple) nel codice sorgente, immediatamente prima del blocco di codice a cui i commenti fanno riferimento, ad esempio:

/// <summary>
///  This class performs an important function.
/// </summary>
public class MyClass{}

Quando si esegue la compilazione con l'opzione /doc, il compilatore cerca tutti i tag XML presenti nel codice sorgente e crea un file di documentazione XML. Per creare la documentazione finale basata sul file generato dal compilatore, è possibile creare uno strumento personalizzato o utilizzare uno strumento come Sandcastle.

Per fare riferimento agli elementi XML (ad esempio, la funzione elabora elementi XML specifici che si desidera descrivere in un commento della documentazione XML), è possibile utilizzare il meccanismo standard (&lt; e &gt;). Per fare riferimento agli identificatori generici in elementi di riferimento di codice (cref), è possibile utilizzare caratteri di escape (ad esempio, cref=”List&lt;T>”) o parentesi graffe (cref=”List{T}”). Come caso particolare, il compilatore analizza le parentesi graffe come parentesi uncinate per rendere il commento relativo alla documentazione meno complesso da creare quando viene fatto riferimento a identificatori generici.

System_CAPS_noteNota

I commenti relativi alla documentazione XML non sono metadati, ovvero non vengono inclusi nell'assembly compilato e pertanto non sono accessibili mediante reflection.

Per altre informazioni, vedere Specifiche del linguaggio C#. La specifica del linguaggio costituisce il riferimento ufficiale principale per la sintassi e l'uso di C#.

Mostra:
© 2016 Microsoft