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

Question

¿Existe alguna manera fácil de producir documentación al estilo de MSDN a partir de la salida 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, intenté configurar Sandcastle recientemente, pero realmente me hizo cruzar los ojos. O me estaba perdiendo algo importante en el proceso o simplemente está demasiado involucrado.

Conozco a alguien que tiene una solución muy fácil de matar.

estoy reiterando aquí porque creo que mi formato hizo que la no invitación a leer el párrafo:

me dio una oportunidad de castillos de arena, pero tuvo un momento muy difícil conseguir que se creó. 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.

Answer 1

Usted está buscando un castillo de arena

Proyecto Página: Sandcastle Releases

Blog: Sandcastle Blog

NDoc Code Documentation Generator for .NET solía ser la herramienta de elección, pero el apoyo ha cesado.

Answer 2

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

Answer 3

Acabo de configurar nuevamente Sandcastle. 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 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 compilación automática, pero estoy absolutamente seguro de que valdrá la pena el esfuerzo.

También eche un vistazo a Sandcastle Help File Builder, esta es una interfaz gráfica de usuario algo más avanzada para ello.

Answer 4

Siga this simple 5 step article y listo. Como beneficio adicional, puede usar H2Viewer para ver archivos Html Help 2.x.

Answer 5

También debe utilizar 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.

Welcome to the Sandcastle Help File Builder Project

Answer 6

utilizo NDoc3