naturales es un generador multilingue de la documentación. Se escribe en Perl y está disponible como software libre de conformidad con la licencia el público en general del GNU. Intenta mantener los comentarios escritos en el código fuente apenas tan legibles como la documentación generada. Es escrito y mantenido por Greg Valure.

Teóricamente, puede generar la documentación de cualquier lengua que pueda apoyar comentarios, o de archivos de texto llano. Cuando está ejecutado, puede documentar automáticamente funciones, variables, clases, y herencia ActionScript 2.0, C#, y de Perl sin importar la documentación existente en el código fuente. En el resto de las idiomas, éstos necesitan ser documentados explícitamente para que sean generadas. Puede generar la documentación en HTML, con los marcos o fuera.

Desemejante Javadoc, no se considera un estándar industrial para documentar en ninguna lengua, aunque la compatibilidad de Javadoc se esté desarrollando para ciertas idiomas. Es utilizado por algunos aficionados a los hobbys y compañías, tales como CNET Networks, Inc. y hospitalidad de los reinos del hierro. Ha ganado renombre entre el ActionScript 2.0 reveladores de porque existe ningún otro generador libre de la documentación que apoya completamente ActionScript 2.0 y porque genera una salida más de alta calidad que los generadores similares que apoyan parcialmente la lengua, tal como ROBODoc .

Ejemplo

Éste es un ejemplo del estilo de la documentación:

/* * Función: Multiplicarse * * Multiplica dos números enteros. * * Parámetros: * x - El primer número entero. * y - El segundo número entero. * * Vuelve: * Los dos números enteros multiplicados juntos. * * Ver también: * * la internacional se multiplica (internacional x, internacional y) {x de vuelta * y; };

Para la comparación, éste es cómo la misma cosa sería documentada con el Javadoc : /** * Multiplica dos números enteros. * * @param x el primer número entero. * @param y el segundo número entero. * @return los dos números enteros multiplicados juntos. * divisoria del @see * la internacional se multiplica (internacional x, internacional y) {x de vuelta * y; };

Ver también

Comparación de los generadores de la documentación

Notas y referencias

class=" del .

Zenithic

Serrières-en-Chautagne

Random links:

Ekwok, Alaska | El municipio de Markaryd | Marqués de Exeter | Pastor de Lemuel C., JR. | Bill Koch (esquiador)