Etiquetas recomendadas para comentarios de documentación (Guía de programación de C#)
El compilador de C# procesa los comentarios de documentación del código y les da formato de código XML en un archivo cuyo nombre se especifica en la opción de la línea de comandos /doc. Para crear la documentación final basándose en el archivo generado por el compilador, se puede crear una herramienta personalizada o usar una herramienta como Sandcastle.
Las etiquetas se procesan sobre construcciones de código, tales como tipos y miembros de tipos.
Nota
Los comentarios de documentación no se pueden aplicar a un espacio de nombres.
El compilador procesará cualquier etiqueta válida en XML. Las siguientes etiquetas proporcionan funcionalidad de uso general en la documentación de usuario.
Etiquetas
(* indica que el compilador comprueba la sintaxis.)
Si desea que aparezcan corchetes angulares en el texto de un comentario de documentación, utilice < y >, como se muestra en el ejemplo siguiente.
/// <summary cref="C < T >">
Vea también
Referencia
/doc (Opciones del compilador de C#)
Comentarios de documentación XML (Guía de programación de C#)