¿Hay una API en.net para leer el archivo de documentación de comentarios XML
documentation intellisense (5)
Aquí hay otro: NuDoc: un lector de documentación API .NET XML
Utiliza el patrón de visitante para recorrer la documentación XML.
Aquí está en GitHub
En esta question veo que Microsoft envía los archivos de documentación XML para el BCL. Me pregunto si alguien sabe si existe una API dentro de .net que pueda usarse para consultar esto en tiempo de ejecución. Sé que podemos analizar los archivos manualmente utilizando la API XML.
El caso de uso es que permitimos que los tipos / ensamblajes personalizados (leídos por terceros) se usen en nuestro sistema, y al seleccionarlos en la interfaz de usuario, nos gustaría extraer la documentación según lo especificado por el creador del tipo / ensamblado personalizado o si no disponible proporcionar otros valores por defecto.
Es posible que desee investigar las siguientes bibliotecas
Pensemos en esto.
Los comentarios XML nunca forman parte de la unidad de montaje. Por lo tanto, la asamblea de terceros de la que está hablando no tendrá ninguna información de la que pueda extraer comentarios.
Ahora, si esos ensamblajes pueden generar archivos XML que contienen esta documentación, probablemente utilizando SandCastle o nDoc, entonces puede leer esos archivos XML como quiera.
La siguiente pregunta es: suponiendo que tenga estos archivos de documentos XML, cómo analizarlos y leerlos.
- Yo sugeriría usar Linq to XML para cargar de forma rápida y sencilla esta documentación. Esto es mejor en muchos aspectos que el procesamiento XSLT que realiza SandCastle. El uso de Linq to XML para hacer esto no debería tomar tanto tiempo, siempre que entienda el esquema / jerarquía XML del archivo de documento XML
Déjame saber cómo va eso O si tienes alguna pregunta
El Sandcastle de Microsoft es una herramienta para extraer documentación de ensamblajes con o sin la ayuda de los archivos de comentarios XML. Ha sido lanzado como código abierto. Puedes intentar echar un vistazo al código de esa herramienta.
Mantengo el proyecto Jolt.NET en CodePlex y he implementado una característica que realiza esta tarea. Consulte la biblioteca Jolt para obtener más información.
En esencia, la biblioteca le permite localizar y consultar un archivo de comentarios de documentos XML para un ensamblaje mediante el uso de los tipos de metadatos en System.Reflection (es decir, MethodInfo , PropertyInfo , etc.).