Blog Calendar

June 2009
Sun Mon Tue Wed Thu Fri Sat
31 1 2 3 4 5 6
7 8 9 10 11 12 13
14 15 16 17 18 19 20
21 22 23 24 25 26 27
28 29 30 1 2 3 4

Visitors Statistics

8
78
11330

June 2009

Etiquetas de documentación XML en C#

Si bien es conocido que existe la manera de documentar el código desde C# con etiquetas XML, en la mayoría de los proyectos que he estado, pocas son las personas que realmente emplean esta herramienta.

Debido al escaso uso de documentación en el código, me dí a la tarea de realizar un pequeño extracto de información sobre las etiquetas que se pueden emplear y como generar la documentación de manera automática. Algunas de las etiquetas que se emplean son las siguientes:

summary: Su contenido se utiliza para indicar un resumen sobre el significado del elemento al que precede. Cada vez que en VS.NET se use el operador “.” para acceder a algún miembro de un objeto o tipo se usará esta información para mostrar sobre la pantalla del editor de texto un resumen acerca de su utilidad.

Ejemplo:
/// <summary> Método que muestra un texto por pantalla </summary>
bool MuestraTexto()
{
   ...
}
 
Read More...