Natural Docs
Natural Docs es un generador de documentación multi-lenguaje. Fue escrito en Perl y está disponible como software libre bajo la licencia GNU General Public License. Uno de sus objetivos es mantener los comentarios originales escritos en el código fuente tan legibles como en la documentación generada. Fue escrito y es mantenido por Greg Valure.
| Natural Docs | ||
|---|---|---|
| Información general | ||
| Tipo de programa | software libre | |
| Autor | Greg Valure | |
| Licencia | GNU General Public License | |
| Información técnica | ||
| Programado en | C# | |
| Versiones | ||
| Última versión estable | 2.0.1 ( 30 de agosto de 2017) | |
| Enlaces | ||
Teóricamente, puede generar documentación de todo lenguaje que soporte comentarios, o de archivos de texto plano. Al ser ejecutado, documenta automáticamente funciones, variables, clases y herencia si el código fuente está en ActionScript, C#, o Perl, sin importar la documentación que pueda haber en el código. Para el resto de los lenguajes, estas entidades deben ser explicitadas para ser generadas. El único formato de salida soportado es el HTML, pudiendo generar páginas con o sin marcos.
Ejemplo editar
El siguiente es un ejemplo del estilo de documentación:
/*
* Function: Multiplicar
*
* Multiplica dos enteros.
*
* Parameters:
* x - El primer entero.
* y - El segundo entero.
*
* Returns:
* El producto de ambos enteros.
*
* Ver también:
* <Dividir>
*/
int Multiplicar (int x, int y)
{ return x * y; };
Como comparación, se muestra el código equivalente con Javadoc:
/**
* Multiplica dos enteros.
*
* @param x El primer entero.
* @param y El segundo entero.
* @return El producto de ambos enteros.
* @see Dividir
*/
int Multiplicar (int x, int y)
{ return x * y; };
Véase también editar
Enlaces externos editar
- Página de Natural Docs (en inglés)
- Características (en inglés)
- Lenguajes soportados (en inglés)
Datos: Q119872
