¿Cómo usar comentarios en línea para documentar miembros en .NET?

Question

¿Cómo puedo documentar un miembro en línea en .Net? Dejame explicar. La mayoría de las herramientas que extraen documentación de los comentarios admiten algún tipo de documentación en línea donde puede agregar un breve después de la declaración del miembro. Algo como:

public static string MyField; /// <summary>Information about MyField.</summary> 

¿Hay alguna manera de hacer esto en C# o en los lenguajes .NET?

Answer 1

No, no se puede. Los comentarios XML solo se admiten como un comentario de nivel de bloque, lo que significa que debe colocarse antes del elemento de código que está documentando. Las herramientas comunes para extraer comentarios XML del código .NET no entienden cómo analizar comentarios en línea como ese. Si necesita esta habilidad, tendrá que escribir su propio analizador.

Answer 2

Sí, sólo hay que poner antes de lo que desea comentar

/// <summary>Information about MyField.</summary> 
public static string MyField; 

Answer 3

No hay una forma integrada de hacerlo. El sistema de documentación XML es jerárquico; define una relación entre la etiqueta <summary /> y los datos que la siguen inmediatamente.