Una de las cosas más importantes en el desarrollo de sistemas es la documentación, sin embargo pocos desarrolladores hacen una documentación del código de forma adecuada, y para ser sincero, resulta hasta tedioso el tener que hacerlo.

Sin embargo, no hay otra alternativa que documentar nuestro desarrollo; para poder hacer la documentación de nuestro software en .Net de forma adecuada, es necesario que tengamos presente que existen algunos tags de xml que debemos entender de manera que podamos hacer una documentación de forma correcta y no solo escribir instrucciones como:

 /// <summary>
 /// This class performs an important function.
 /// </summary>
 public class MyClass{}

¿Cuál es la intención de estos comentarios que podrían parecer complicados y engorrosos? Pues, es simple, existen programas especialmente diseñados para leer los comentarios XML que hemos generado en nuestro código y que permiten crear todo un archivo completo correctamente estructurado y que contendrá toda la documentación. Ahora nos podemos olvidar de de escribir la documentación aparte o preocuparnos por darle un formato ordenado. Pero antes de empezar… escribamos bien los comentarios.

Afortunadamente podemos encontrar una guía completa de documentación para proyectos de .Net en la web de Microsoft.

URL para comentarios XML: http://msdn2.microsoft.com/es-es/library/b2s063f7(VS.80).aspx

Saludos.