NDoc es un generador de documentación de código para la Infraestructura de Lenguaje Común creado por Jason Diamond, Jean-Claude Manoli y Kral Ferch. Está licenciado bajo la Licencia Pública General de GNU .
Cómo funciona
NDoc utiliza dos fuentes para generar la documentación. La primera es un archivo de ensamblado producido al compilar el código fuente. La otra es un archivo de documentación XML pregenerado , generalmente producido al analizar el código fuente en busca de comentarios especiales ( los compiladores de C# de .NET Framework y Mono admiten esto mediante el /docargumento de línea de comandos " ").
El archivo de ensamblaje se consulta mediante reflexión para obtener la lista de clases , métodos , etc. El archivo XML se analiza para extraer el texto de la documentación.
NDoc utiliza complementos para admitir diversos formatos de salida, como CHM , Microsoft Help Viewer y páginas web estilo MSDN . También incluye complementos incompletos como punto de partida para desarrolladores, como el complemento LaTeX y las páginas web estilo Javadoc . NDoc cuenta con una interfaz gráfica de usuario para facilitar el proceso de generación.
Limitaciones y desarrollo futuro
La última versión de NDoc no es compatible con .NET Framework versión 2.0. Aunque existen versiones alfa internas [ 1 ] [ 2 ] que sí son compatibles con .NET 2.0, a partir de 2006Hay muy poca actividad en el proyecto NDoc. El desarrollador de NDoc, Kevin Downs, ha dicho que ya no trabaja en NDoc debido a la falta de financiación y a las amenazas en su contra, y que está dispuesto a ceder la administración del proyecto. [ 3 ] Más recientemente, Kim Christensen retomó el proyecto y continúa el desarrollo del NDoc original como NDoc3. [ 4 ]
Véase también
- Doxygen es una herramienta madura para la generación de documentos que también puede crear diagramas de clases y producir documentación en muchos otros lenguajes.
- Sandcastle : una aplicación similar de Microsoft .
- Sandcastle Help File Builder : una interfaz gráfica de usuario gratuita para Sandcastle que ofrece funciones similares a las de Ndoc.
- Visual Expert : un generador de documentación que también proporciona árboles de llamadas , matriz CRUD , análisis de impacto y revisión de código para PL/SQL , Transact-SQL y otros lenguajes.
- Comparación de generadores de documentación
Referencias
Enlaces externos
- Sitio web oficial de NDoc
- Sitio web de NDoc3, sucesor oficial de NDoc.
- NDoc 2005 y NDoc Reloaded : bifurcaciones de NDoc
- Generadores de documentación gratuitos