Natural Docs

Natural Docs
Natural Docs
Autor
Greg Valure
NaturalDocs.org
Información general
Última versión estable 1.4
8 de mayo de 2008
Género Generador de documentación
Sistema operativo Multi-plataforma
Licencia GNU General Public License
En español ?

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.

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

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

Enlaces externos


Wikimedia foundation. 2010.

Игры ⚽ Нужна курсовая?

Mira otros diccionarios:

  • Natural Docs — Original author(s) Greg Valure Stable release 1.5 / July 22, 2010 Operating system Cross platform …   Wikipedia

  • Natural Docs — Entwickler Greg Valure Aktuelle Version 1.51 (21. Dezember 2010) Betriebssystem Plattformunabhängig (benötigt Perl) Kategorie Software Dokumentationswerkzeug …   Deutsch Wikipedia

  • Natural Gas Act of 1938 — Related Laws Federal Power Act of 1935 Relevant Court Cases FPC V. NATURAL GAS PIPELINE CO., 315 U. S. 575 (1942) The Natural Gas Act of 1938 was the first occurrence of the United States federal government regulating the natural gas industry. It …   Wikipedia

  • Natural Bridge (Virginia) — Natural Bridge U.S. National Register of Historic Places U.S. National Historic Landmark …   Wikipedia

  • Natural Dam, Arkansas —   Unincorporated community   …   Wikipedia

  • Carnegie Museum of Natural History — Das Museum Das Carnegie Museum of Natural History ist ein Museum für Naturgeschichte in Pittsburgh im US Bundesstaat Pennsylvania. Inhaltsverzeichnis …   Deutsch Wikipedia

  • University of Kansas Natural History Museum — Dyche Hall, University of Kansas U.S. National Register of Historic Places …   Wikipedia

  • List of natural disasters by death toll — A natural disaster is defined as a hazard which occurs naturally, that is a disaster that is not brought about by acts of human beings. A natural disaster might be caused by earthquakes, flooding, volcanic eruption, landslide, etc. In order to be …   Wikipedia

  • Renewable natural gas — Renewable natural gas, also known as sustainable natural gas, is a biogas which has been upgraded to a quality similar to natural gas. A biogas is a gas obtained from biomass. By upgrading the quality to that of natural gas, it becomes possible… …   Wikipedia

  • Field Museum of Natural History — FMNH redirects here. For the Florida Museum of Natural History, see FLMNH. Field Museum of Natural History U.S. National Register of Historic Places …   Wikipedia

Compartir el artículo y extractos

Link directo
Do a right-click on the link above
and select “Copy Link”