Natural Docs es un generador de documentación en varios idiomas . Está escrito en C# y está disponible como software libre bajo los términos de la AGPL . Intenta mantener los comentarios escritos en el código fuente tan legibles como la documentación generada. Está escrito y mantenido por Greg Valure.
En teoría, Natural Docs puede generar documentación desde cualquier lenguaje que admita comentarios o desde archivos de texto sin formato. Cuando se ejecuta, puede documentar 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 documentarlas explícitamente para que se generen. Puede generar documentación en HTML , ya sea con marcos o sin ellos.
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. y Iron Realms Entertainment . [3] [4] Ha ganado popularidad entre los desarrolladores de ActionScript porque no existe otro generador de documentación gratuito que admita completamente ActionScript y porque genera resultados de mayor calidad que los generadores similares que admiten parcialmente el lenguaje, como ROBODoc .
Este es un ejemplo del estilo de documentación:
/* * Función: Multiplicar * * Multiplica dos números enteros. * * Parámetros: * x - El primer número entero. * y - El segundo número entero. * * Devuelve: * Los dos números 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 Los dos enteros multiplicados entre sí. * @see Dividir */ int Multiplicar ( int x , int y ) { return x * y ; }