NDoc es un generador de documentación de código para Common Language Infrastructure creado por Jason Diamond, Jean-Claude Manoli y Kral Ferch. Tiene la licencia GNU General Public License .
Desarrollador (es) | Diamond, Manoli y col. |
---|---|
Lanzamiento estable | 1.3.1 / 25 de enero de 2005 |
Sistema operativo | Multiplataforma (?) |
Tipo | Generador de documentación |
Licencia | GNU GPL |
Sitio web | ndoc |
Cómo funciona
NDoc utiliza dos fuentes para generar documentación. El primero es un archivo de ensamblaje producido al compilar el código fuente. El otro es un archivo de documentación XML pregenerado, normalmente producido analizando el código fuente en busca de comentarios especiales (los compiladores de C # de .NET Framework y Mono lo admiten mediante el /doc
argumento de línea de " " comandos).
El archivo de ensamblaje se consulta mediante la reflexión para obtener la lista de clases , métodos , etc. El archivo XML se analiza para el texto de la documentación.
NDoc utiliza complementos para admitir varios formatos de salida diferentes, incluidos CHM , Microsoft Help Viewer , páginas web de estilo MSDN . Los complementos incompletos también se incluyen como puntos de partida para los desarrolladores, como el complemento LaTeX y las páginas web estilo Javadoc . NDoc viene con una interfaz gráfica de usuario para facilitar el proceso de generación.
Limitaciones y desarrollo futuro
La última versión de lanzamiento de NDoc no es compatible con .NET Framework versión 2.0. Aunque hay versiones alfa internas [1] [2] que admiten .NET 2.0, a partir de 2006[actualizar], hay muy poca actividad en el proyecto NDoc. El desarrollador de NDoc, Kevin Downs, ha dicho que ya no está trabajando en NDoc debido a la falta de financiación y las amenazas en su contra, y que está dispuesto a ceder la administración del proyecto. [3] Más recientemente, Kim Christensen tomó la pelota y continúa el desarrollo del NDoc original como NDoc3 [4]
Ver también
- Doxygen : una herramienta de generación de documentos madura que también puede crear diagramas de clases y producir documentación de muchos otros lenguajes.
- Sandcastle : una aplicación similar de Microsoft .
- Sandcastle Help File Builder : una interfaz gráfica de usuario gratuita para Sandcastle que proporciona funciones similares a Ndoc.
- Visual Expert : un generador de documentación que también proporciona árboles de llamadas , matriz CRUD , análisis de impacto , 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 - horquillas de NDoc