Hoy hemos tenido una charla sobre el xml que se genera cuando compilamos, resulta que aun mucha gente no sabe que esto genera la documentación. Casi nunca documentamos, porque no vemos ningún fruto a los comentarios.
Para el que no sepa que es la documentación del código y para que vale, lee esto: MSDN
Depende de la versión del visual studio que tengas puede que tengas que instalar algún complemento para la documentación. La buena noticia es que las nuevas versiones del visual ya tiene la documentación para VB (antes solo estaba para C#)
Hasta el framework 3.5, prueba el NDoc, yo lo he usado y es fantástico. Super fácil de instalar y probar, con un montón de opciones para configurar.
También está disponible el Sandcastel (es válido para framework 4.0)
- Ayuda
- Instalarlo
Es útil, pero como todo si no lo has usado nunca vas a tardar un poco en verlo, para mi un pega es que es lento. Si no haces documentación empieza a escribirla según haces el código y prueba como sale la documentación para ver que sirve para algo y lo que puedes mejorar en tus comentarios.
No hay comentarios:
Publicar un comentario