visual studio generar documentar documentacion crear codigo clases visual-studio xslt documentation sandcastle xml-comments

visual studio - studio - .Net Comentario XML en la documentación de la API



generar documentacion visual studio 2015 (6)

¿Hay alguna manera fácil de producir documentación al estilo MSDN del resultado XML de Visual Studio?
No soy lo suficientemente paciente como para establecer un buen xslt porque sé que no soy la primera persona en cruzar este puente.

Además, traté de instalar el castillo de arena recientemente, pero realmente hizo que mis ojos se cruzaran. O me estaba perdiendo algo importante en el proceso o simplemente está demasiado involucrado.

Sé que alguien por ahí tiene una solución muy fácil de matar.

Estoy reiterando aquí porque creo que mi formateo hizo que ese párrafo no invitara a leer:

Le di una oportunidad a Sandcastle, pero me costó trabajo configurarlo. Lo que realmente tengo en mente es algo mucho más simple.

Es decir, a menos que simplemente no entiendo el proceso de castillos de arena. Parecía un exceso de equipaje extra para mí solo para producir algo agradable para que los probadores trabajen.


Echa un vistazo a Sandcastle , que hace exactamente eso. También es una de las soluciones más simples que existen, y es más o menos la herramienta de elección, por lo que, a la larga, tal vez podríamos ayudarlo a configurar Sandcastle si especifica qué problemas encontró durante la instalación.






Acabo de configurar Sandcastle de nuevo. Intente instalarlo (la versión de mayo de 2008) y busque SandcastleGui.exe o algo similar (está en la carpeta de ejemplos o más).

Haga clic en Agregar ensamblaje y agregue su ensamblaje o ensamblajes, agregue cualquier archivo de documentación .xml (los generados por el compilador si habilitó esa opción) y luego compile.

Llevará algún tiempo, pero el resultado valdrá la pena. En realidad, buscará material de MSDN, por lo que la documentación resultante también tendrá la herencia de clase hasta System.Object con enlaces a MSDN y esas cosas.

Sandcastle parece un poco complicado al principio, especialmente cuando quieres usarlo en una construcción automatizada, pero estoy absolutamente seguro de que valdrá la pena el esfuerzo.

También echa un vistazo a Sandcastle Help File Builder , esta es una GUI algo más avanzada para ello.