2010-11-29 10 views
12

Acabo de descubrir que puedo generar documentación XML para mi proyecto con VisualStudio 2010 con las etiquetas '///' en el código ... Parece mágico, pero ¿qué puedo hacer con eso? ¿Existe alguna aplicación que pueda convertirme en un "doc hermoso" con el archivo XML? ¿O convertirlo en un documento HTML?¿Qué puedo hacer con mi documentación XML?

¡Muchas gracias por todas las respuestas!

Respuesta

11

Hay varias aplicaciones por ahí que puede tomar sus comentarios XML y generar documentos de la API de MSDN estilo para usted (que trabajan en la lista):

Sandcastle (Microsoft)
NDoc
Live Documenter

+0

+1 para Sandcastle, pero creo que NDoc está muerto (la última versión es de 2005) y Sandcastle es su reemplazo. –

+0

Gracias .. Voy a probar Sandcastle entonces ... – bAN

+6

Aparentemente, el propio Sandcastle [perdió el soporte de Microsoft] (https://sandcastle.codeplex.com/discussions/398496) recientemente, pero el [Sandcastle Help File Builder] (https: //shfb.codeplex.com/) proyecto todavía está vivo y ha tomado el control del código Sandcastle. – sinelaw

0

Uso GhostDoc para ayudar a generar los comentarios del documento XML, y Sandcastle con Sandcastle Help File Builder para convertirlo en un archivo de ayuda compilado, que se parece a la documentación de MSDN.

Puede encontrar una guía detallada para usar el Creador de archivos de ayuda de Sandcastle/Sandcastle here.

También probé Doxygen y encontré que era bastante fácil de usar, pero prefería el aspecto de la documentación que producía Sandcastle.

+0

El problema con doxygen es que usa un formato diferente para la documentación que VS IDE, lo que significa que no obtendrá ninguna información en intellisense. – RubberDuck

0

Hay una herramienta alternativa DocFX desarrollada por Microsoft.

Genera API doc en formato HTML como this.

Cuestiones relacionadas