¿Cuál es la diferencia entre // y /// en Visual Studio?

Question

Stylecop me dice que use /// en lugar de // cuando estoy comentando. ¿Cuál es la diferencia semántica para esos dos y cuándo debo usar cuál?

Answer 1

// denota sus propios comentarios personales, donde /// denotan comentarios que pueden contener datos especiales, por ej. marcado para la interpretación por Visual Studio - como:

/// <summary> 
/// This class does something. 
/// </summary> 
class Bob { 
    ... 
} 

Esto le dirá Visual Studio el resumen de la clase Bob, y que a continuación se mostrará en la caja de la finalización de código.

Answer 2

Encontrado yo mismo al pasar por otras normas StyleCop:

uso // cuando commentin

Uso /// cuando se documentan para los encabezados de documentación XML

Answer 3

La triple barra le da una plantilla que se genera de forma automática con los parámetros y otras características no automáticamente para usted

/// <summary> 
/// Here is your comment 
/// </summary> 
/// <param name="sender">parameter generated automatically</param> 
/// <param name="e">as above</param> 
void BindableCollection_CollectionChanged(object sender, NotifyCollectionChangedEventArgs e) 

Este enfoque significa que una herramienta como NDoc puede entonces arrastre a su fuente para crear los archivos de documentación automágicamente. Doble barra simplemente no lo corta ....

Answer 4

No hay diferencia semántica, es solo un estilo de codificación o comentario. .NET elige elegir eso para comentarios. En general, es útil seguir estas reglas para las herramientas de documentación de códigos automáticos, como sandcastle. Por ejemplo, Doxygen tiene un estilo de comentario completamente diferente para el código C++. Por lo tanto, es principalmente para la coherencia y los estándares