viernes, 10 de marzo de 2017

Documentación 1.1

Es complicado hacer una documentación del código, aunque no imposible ( siempre que todos los implicados pongan de su parte).

Tengo un varios proyectos que documentar y muchos de ellos hacen referencia a un servicio web.
Al activar la documentación, salen un monto de advertencias que indican que el sw no tiene sus correspondientes comentarios de código.   

Mirando por internet hay varias soluciones pero la que me parece mejor es añadir  en el fichero Reference.cs del servicio web
Al inicio del fichero : #pragma warning disable 1591

Al final del fichero: #pragma warning restore 1591


Desactivar la advertencia en todo el proyecto también es posible, pero es arriesgado en equipos no acostumbrados  a escribir documentación técnica 


Yo personalmente para sacar la documentación uso el Sandcastel