Estaba escribiendo en lala land cuando de repente escribí un 3'd '/' en un comentario. Originalmente un comentario va verde con 2 '/' s :¿Qué hace 3 '/' s en una fila en C#?
Pero con el tercer guión, se va gris '///' :
¿Tiene esto algún significado específico? ¿O simplemente cambió de color?
denota un XmlComment, más de los cuales se puede leer sobre 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)
{
}
Editar: como se sugiere a continuación, sino que también proporciona IntelliSense orientación, como la imagen de abajo demuestra.
Puede valer la pena mencionar que además de generar documentación, estos también proporcionan detalles para las ventanas emergentes Intellisense en Visual Studio. –
Buena idea, han agregado. – glosrob
Bien hecho también. Aunque la forma en que trabajas con ese esquema de color ...;) –
comentarios Tres-barra son para el constructor documentación. Puede generar documentación de sus API directamente desde la fuente. Puede documentar qué hace su API, qué parámetros toma, qué excepciones arroja, 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 documentación a partir de estas etiquetas usando Visual Studio: link.
/// es para XML comentario. proporciona un comentario con formato XML. También puede crear documentos XML a partir de esto utilizando las opciones /doc: al compilar desde este como
csc /doc:filedoc.xml program.cs
Por supuesto '///' es casi el color. Así como '" "' se trata de hacer las cosas rojas ;-) – Joey