Esiste uno standard (come phpdoc o docstring di Python) per commentare il codice C#?

Question

Esiste una convenzione standard (come phpdoc o docstring di Python) per commentare il codice C# in modo che la documentazione della classe possa essere generata automaticamente dal codice sorgente?

Answer 1

Puoi utilizzare commenti in stile XML e utilizzare strumenti per estrarre tali commenti nella documentazione API.

Ecco un esempio dello stile del commento:

/// <summary>
/// Authenticates a user based on a username and password.
/// </summary>
/// <param name="username">The username.</param>
/// <param name="password">The password.</param>
/// <returns>
/// True, if authentication is successful, otherwise False.
/// </returns>
/// <remarks>
/// For use with local systems
/// </remarks>
public override bool Authenticate(string username, string password)

Alcuni elementi per facilitare questo sono:

GhostDoc, che forniscono un singolo tasto di scelta rapida per generare automaticamente commenti per una classe o un metodo.Castello di sabbia, che genera documentazione in stile MSDN dai commenti XML.

Answer 2

/// <summary>
///
/// </summary>
/// <param name="strFilePath"></param>

http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

Answer 3

Microsoft utilizza "Commenti sulla documentazione XML" che fornirà descrizioni intellisense IDE e consentirà inoltre di generare automaticamente documentazione in stile MSDN utilizzando uno strumento come Sandcastle se si attiva la generazione dell'output del file XML.

Per attivare la generazione del file XML per la documentazione, fare clic con il pulsante destro del mouse su un progetto in Visual Studio, fare clic su "Proprietà" e andare alla scheda "Crea".Verso il basso puoi specificare una posizione per il file di output dei commenti XML.

Answer 4

Le risposte precedenti sottolineano perfettamente la sintassi XML.Volevo solo inserire la mia raccomandazione per il generatore di librerie di aiuto nDoc gratuito (e open source). che analizza tutti i commenti in un progetto.

Answer 5

C# è integrato comandi di documentazioneDivertiti!

Answer 6

Mi è sempre stato detto di utilizzare i commenti in blocco aperti con 2 o più asterischi per delimitare i commenti sulla documentazione.

/**
Documentation goes here.
(flowerboxes optional) 
*/