Al igual que todos aquellos que sintieron curiosidad por este tema, yo también soy Desarrollador, disfruto solucionando problemas, y no me canso de agregar código a mi aplicación…pero si alguien se atreve a pedirme que agregue documentación a mi código, siento que debo levantarme de mi lugar e irme. 
En serio lo entiendo, casi siempre que le he pedido a algún programador que agregue comentarios (para no usar la palabra documentación) aun que sea a los métodos, puedo ver la inconformidad en el rostro.
Que es lo que pasa?
La mayoría de nosotros pensamos que documentar es una pérdida de tiempo, no es cierto?. Pensamos que nuestro tiempo es muy valioso y que debería aprovecharse escribiendo código, no documentándolo…además lo que refuerza esta actitud es que casi siempre trabajamos para mostros mismos, por lo que sentimos que esos comentarios en nuestro propio código están de más, no?
Pero, cuando pasa el tiempo y debemos utilizar de nuevo ese código, y volvemos a abrir el archivo; cuando vemos el código después de tanto tiempo, sentimos que un mínimo de comentarios nos ayudarían en ese momento, para no tener que leer de nuevo las líneas y tratar de acordarnos que fue lo que hicimos. Y perder el tiempo tratando de recordar.
Y si el código es de otro programador, entonces ahí si queremos comentarios, cuando algunos comentarios estamos agradecidos, ya que una línea donde se explica es mejor que no tener nada. Tal vez sea cuestión de orgullo, de pensar que no necesitamos documentar nuestro código, pero la verdad es que si se necesita.
Como se agrega?
El Visual Studio nos ofrece tanto a quienes programamos en C# o en VB, la posibilidad de agregar comentarios de una forma simple y fácil de usar.
El VB solo debemos escribir tres apostrofes (‘’’) para ver algo como esto: 
Este comentario es visible cuando estamos en la IDE y usamos el método, el intellisense nos presenta esta información que nos puede servir de guía:
Si estamos escribiendo nuestro código en C#, debemos usar tres barras diagonales ( ///).
Es muy fácil e incluso hace que nuestro código se vea más profesional, este simple detalle nos hace sentir seguros, y le inspira confianza a quien use nuestro código. Animo solo deben comentar el mínimo necesario, no más! 
Para mayor referencia pueden visitar estas direcciones (están en ingles):
Para c#: http://msdn.microsoft.com/en-us/magazine/cc302121.aspxPara VB: http://msdn.microsoft.com/en-us/library/ms172653(v=VS.80).aspx
No hay comentarios:
Publicar un comentario