Médicos naturales

Natural Docs es un generador de documentación multilingüe . Está escrito en C# y se distribuye como software libre bajo la licencia AGPL . Su objetivo es que los comentarios del código fuente sean tan legibles como la documentación generada. Es desarrollado y mantenido por Greg Valure.

En teoría, Natural Docs puede generar documentación a partir de cualquier lenguaje que admita comentarios o de archivos de texto plano. Al ejecutarse, documenta automáticamente funciones, variables, clases y herencia de ActionScript , C# y Perl, independientemente de la documentación existente en el código fuente. En todos los demás lenguajes, es necesario documentar explícitamente estos elementos para que se generen. Puede generar documentación en HTML , con o sin marcos.

A diferencia de Javadoc , no se considera un estándar de la industria para documentar en ningún lenguaje, aunque puede incorporar documentación Javadoc para lenguajes con "soporte completo". ^{[ 2 ]} Es utilizado por algunos aficionados y empresas, como CNET Networks, Inc. e Iron Realms Entertainment . ^{[ 3 ] [ 4 ]} Ha ganado popularidad entre los desarrolladores de ActionScript porque no existe ningún otro generador de documentación gratuito que soporte completamente ActionScript y porque genera una salida de mayor calidad que generadores similares que soportan parcialmente el lenguaje, como ROBODoc .

Este es un ejemplo del estilo de documentación:

/*  * Función: Multiplicar  *  * Multiplica dos enteros.  *  * Parámetros:  * x - El primer entero.  * y - El segundo entero.  *  * Devuelve:  * Los dos enteros multiplicados entre sí.  *  * Ver también:  * <Dividir>  */ int Multiplicar ( int x , int y ) { return x * y ; }

A modo de comparación, así es como se documentaría lo mismo con Javadoc :

/**  * Multiplica dos enteros.  *  * @param x El primer entero.  * @param y El segundo entero.  * @return El resultado de multiplicar los dos enteros.  * @see Divide  */ int Multiply ( int x , int y ) { return x * y ; }

• Comparación de generadores de documentación

• Página principal de Natural Docs
• Lista de características
• Lista de idiomas compatibles