Como Usar Natural Docs

Universidad
Salesiana de Bolivia
Ingeniería de Sistemas

Docente: Lic. Ivan Fernandez
Materia: Ingeniería de Software II
Alumno: Ingrid M. Rocha Mamani
Fecha: 9 de Noviembre del 2012

Cochabamba – Bolivia

Contenido
1. INTRODUCCION 2
2. CARACTERISTICAS FUNDAMENTALES DE LA HERRAMIENTA 2
Soporte de idiomas completa 2
a. Documentación de código completa. 2
b. Diagramas deherencia. 2
c. Compatibilidad Javadoc. 2
d. Auto-evaluación del alcance. 2
Soporte de idioma básico 2
a) Documentación explícita solamente. 2
b) No hay diagramas de herencia. 2
c) Natural Docs sólo comentarios. 2
3. VENTAJAS AL TRABAJAR CON DICHA HERRAMIENTA 3
Fuente Documentación 3
I. Sintaxis Natural, legible 3
II. Varios idiomas 3
III. Añada su propio idioma 3
IV.Javadoc Compatibilidad 3
V. Palabras clave flexibles 3
VI. Temas personalizados e índices 3
VII. Listas 3
La salida generada 4
a) Documentación Atractivo 4
b) Potente Estructura CSS 4
c) HTML con o sin marco 4
d) Buscar, No requiere servidor 4
e) En todas partes Tooltips 4
f) No haga caso de los prefijos en el Índice de 4
Programa 4
1. Diferencial Build Process 42. Arquitectura extensible 4
3. Archivos de configuración de Intelligent 4
4. Libre y Abierto 4
4. DESVENTAJAS DE LA HERRAMINETA 5
5. PRESENTACION DE UN EJEMPLO DE LA HERRAMIENTA 5
Parámetros necesarios: 5
6. CONCLUCIONES 8
7. BIBLIOGRAFIA 8

1. INTRODUCCION

Si eres desarrollador, documentar es siempre muy importante (es un rollo, pero es importante), y no solo porque es casiseguro que luego tu código sea mantenido por otra persona, si no porque pasa el tiempo y seguramente ni recuerdes porque hiciste esa función de esa manera o de otra.

Natural Docs, Desarrollado por Greg Valure, es una herramienta open source para generar documentación escrito en PERL que soporta múltiples lenguajes de programación (por defecto mas de 19, entre los que se incluyen Java, C++,PLSQL, JavaScript, ADA, etc…).
Su forma de uso es muy simple.  Una vez que descomprimimos el interior te darás cuenta que posee una serie de archivos y carpetas, junta todo en una carpeta por ejemplo con nombre “NaturalDocs“.

2. CARACTERISTICAS FUNDAMENTALES DE LA HERRAMIENTA
Soporte de idiomas completa
Los siguientes idiomas tienen soporte total en el idioma, lo que significa que ustedobtiene:
a. Documentación de código completa.
Todas las funciones, variables y clases aparecerán en la salida, independientemente de si has escrito nada por ellos. Esto se puede desactivar con la -do la opción de línea de comandos.
b. Diagramas de herencia.
Ellos aparecerán en la salida siempre que sea apropiado.
c. Compatibilidad Javadoc.
Natural Docs puede leer la mayoría decomentarios Javadoc e incluirlos en la salida. También puede escribir documentación Natural Docs sin líneas temáticas mediante el uso de los símbolos de comentario Javadoc.
d. Auto-evaluación del alcance.
La clase de un tema forma parte de está determinada por el código fuente en lugar de la clase y los temas de la sección.
* C # (1,1, algunos 2,0)
* Perl
* ActionScript (2 y 3)Soporte de idioma básico
Los siguientes idiomas tienen soporte lenguaje básico, lo que significa que usted tiene:
a) Documentación explícita solamente.
Sólo cosas que escribes Natural Docs para documentación aparecerá en la salida.
b) No hay diagramas de herencia.
c) Natural Docs sólo comentarios.
También tienen que incluir una línea de tema.
* C / C + +
* Java
*PHP
* Pitón
* PL / SQL
* Visual Basic
* Pascal / Delphi
* Ada
* JavaScript
* Rubí
* Tcl
* ColdFusion
* Montaje
* Fortran (formato libre solamente)
* Makefiles
* Texto sin formato
|

3. VENTAJAS AL TRABAJAR CON DICHA HERRAMIENTA
Natural Docs ofrece una sintaxis abreviada para la documentación de los grandes grupos...