Stavo programmando su Lala Land quando improvvisamente ho digitato un 3'd '/' in un commento. Originariamente un commento va verde con 2 '/' s :Cosa fanno i 3 '/ di una riga in C#?
Ma con il terzo trattino, va grigio '///' :
Ha qualche significato specifico? O ha solo cambiato colore?
Denota un XmlComment, di cui è possibile leggere ulteriori informazioni su MSDN. Ad esempio,
/// <summary>
/// Method summary - a method that does something
/// </summary>
/// <param name="i">Description of param</param>
/// <param name="s">Description of param</param>
/// <returns>An object of some sort or other</returns>
public object AMethod(int i, string s)
{
}
Edit: come suggerito qui di seguito, ma fornisce anche IntelliSense guida, come l'immagine qui sotto mostra.
Potrebbe essere utile menzionare che oltre a generare documentazione, questi forniscono anche dettagli per i popup di Intellisense in Visual Studio. –
Buona idea, ho aggiunto. – glosrob
Ben fatto anche. Però come lavori con quella combinazione di colori ...;) –
commenti Tre-slash sono per il costruttore documentazione. Puoi generare documentazione delle tue API direttamente dalla fonte. Puoi documentare cosa fa l'API, quali parametri richiede, quali eccezioni genera, ecc. Nella tua fonte. Microsoft fornisce strumenti per verificare che la documentazione sia sincronizzata con l'API effettiva. Ad esempio, se aggiungi, rimuovi o rinomina un parametro, ma dimentichi di documentare la modifica, riceverai un avviso.
Ecco come si genera documentazione da questi tag utilizzando Visual Studio: link.
/// è per il commento XML. fornisce un commento in formato XML. Puoi anche creare un documento XML da questo utilizzando le opzioni /doc: durante la compilazione come
csc /doc:filedoc.xml program.cs
Ovviamente '///' è proprio il colore. Proprio come '" "' si tratta di rendere le cose rosse ;-) – Joey