Comentario .Net XML en la documentación API

Question

¿Existe una manera sencilla de producir documentación estilo MSDN a partir de la salida XML de Visual Studio?
No tengo la paciencia suficiente para configurar un buen xslt porque sé que no soy la primera persona en cruzar este puente.

Además, intenté montar un castillo de arena recientemente, pero realmente me hizo cruzar los ojos.O me faltaba algo importante en el proceso o simplemente es demasiado complicado.

Sé que alguien tiene una solución muy sencilla y agradable.

Lo reitero aquí porque creo que mi formato hizo que ese párrafo no invitara a leer:

Probé Sandcastle pero me costó mucho configurarlo.Lo que realmente tengo en mente es algo mucho más simple.

Es decir, a menos que simplemente no entienda el proceso del castillo de arena.Me pareció un montón de equipaje extra sólo para producir algo agradable con lo que pudieran trabajar los evaluadores.

Answer 1

Estás buscando un castillo de arena.

Página del proyecto: Lanzamientos de castillos de arena

Blog: Blog de castillos de arena

Generador de documentación de código NDoc para .NET solía ser la herramienta preferida, pero el apoyo prácticamente ha cesado.

Answer 2

Mira esto Castillo de arena, que hace exactamente eso.También es una de las soluciones más simples que existen y es más o menos la herramienta preferida, por lo que, a largo plazo, tal vez podamos ayudarlo a configurar Sandcastle si especifica qué problemas encontró durante la configuración.

Answer 3

También deberías utilizar el generador de archivos de ayuda de Sandcastle.Le proporciona una GUI similar a ndoc para generar archivos de ayuda, de modo que no tenga que hacer nada desde el símbolo del sistema.

Bienvenido al proyecto de creación de archivos de ayuda de Sandcastle

Answer 4

Seguir este sencillo artículo de 5 pasos y ya casi has terminado.Como beneficio adicional puedes utilizar Visor H2 para ver archivos HTML Help 2.x.

Answer 5

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

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

Tomará algún tiempo, pero el resultado voluntad valdrá la pena el esfuerzo.De hecho, buscará cosas de MSDN, por lo que la documentación resultante también tendrá la herencia de clases hasta System.Object con enlaces a MSDN y demás.

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

Échale un vistazo también a Generador de archivos de ayuda de Sandcastle, esta es una GUI algo más avanzada.

Answer 6

yo suelo NDoc3