.Net Comentario XML en la documentación de la API

votos
15

¿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.

Publicado el 03/08/2008 a las 23:03
fuente por usuario
En otros idiomas...                            


6 respuestas

votos
9

Usted está buscando Sandcastle

Página del proyecto: Lanzamientos de Sandcastle

Blog: Sandcastle Blog

NDoc Code Documentation Generator para .NET solía ser la herramienta de elección, pero el soporte se ha detenido.

Respondida el 03/08/2008 a las 23:12
fuente por usuario

votos
5

También debe usar el Creador de archivos de ayuda de Sandcastle. Le proporciona un ndoc como GUI para generar archivos de ayuda para que no tenga que hacer nada desde el símbolo del sistema.

Bienvenido al Proyecto de Creador de archivos de ayuda de Sandcastle

Respondida el 19/09/2008 a las 16:22
fuente por usuario

votos
5

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.

Respondida el 03/08/2008 a las 23:14
fuente por usuario

votos
3

Sigue este simple artículo de 5 pasos y ya casi has terminado. Como beneficio adicional, puede usar H2Viewer para ver archivos Html Help 2.x.

Respondida el 04/08/2008 a las 11:31
fuente por usuario

votos
3

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.

Se llevará algún tiempo, pero el resultado va a valer la pena el esfuerzo. 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.

Respondida el 04/08/2008 a las 11:27
fuente por usuario

votos
2

Yo uso NDoc3

Respondida el 21/02/2010 a las 23:12
fuente por usuario

Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more