suma - ¿Qué hace 3 ''/'' s en una fila en C#?
recorrer matriz c# (3)
Estaba programando en lala laland cuando de repente escribí un 3''d ''/'' en un comentario. Originalmente, un comentario se vuelve verde con 2 ''/'' s :
Pero con el tercer guión, se pone gris ''///'' :
¿Esto tiene algún significado específico? ¿O simplemente cambió de color?
Denota un XmlComment, más de los cuales se puede leer en MSDN . Por ejemplo,
/// <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)
{
}
Edición: como se sugiere a continuación, también proporciona una guía de IntelliSense , como lo demuestra la siguiente imagen.
Los comentarios de tres barras son para el creador de documentación. Puede generar documentación de sus API directamente desde la fuente. Puede documentar lo que hace su API, los parámetros que toma, las excepciones que lanza, etc. directamente en su fuente. Microsoft proporciona herramientas para verificar que su documentación está sincronizada con la API real. Por ejemplo, si agrega, elimina o cambia el nombre de un parámetro, pero se olvida de documentar el cambio, recibirá una advertencia.
Así es como se genera la documentación de estas etiquetas mediante Visual Studio: link .
///
es para el comentario XML. proporciona un comentario con formato XML. También puede crear un documento XML a partir de este usando las opciones /doc:
mientras compila de este como
csc /doc:filedoc.xml program.cs