Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com
Answertopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

Debian GNU/Linux Reference Guide
Prev Home Next

13.9.4 Programaci�n ilustrada

En vez de escribir c�digo que contenga documentaci�n, el programador ilustrado escribe documentaci�n que contiene c�digo. Este enfoque asegura una buena documentaci�n del programa.

Para m�s informaci�n sobre programaci�n ilustrada, v�ase Literate Programming.


13.9.4.1 Noweb

Preparaci�n:

     # apt-get install nowebm

Referencias para Noweb:

Esta herramienta de la programaci�n ilustrada del tipo WEB es mucho m�s sencilla ya que provee extensibilidad e independencia de lenguaje. [57] Cuando se invoca noweb, escribe el c�digo fuente del programa en los archivos mencionados en el archivo noweb y crea un archivo TeX para la composici�n de la documentaci�n.

El paquete Debian ifupdown es un buen ejemplo.

     $ apt-get source ifupdown
     $ cd ifupdown*
     $ make ifupdown.pdf ifupdown.ps

13.9.4.2 Doxygen

Preparaci�n:

     # apt-get install doxygen doxygen-doc doxygen-gui

Referencias para Doxygen (�creado por doxygen!):

Puede generar documentaci�n HTML, RTF, p�ginas de manual Unix, PostScript y PDF (usando LaTeX) para C++, C, Java, IDL y, con en cierto grado, para programas en PHP y C#. Doxygen es compatible con JavaDoc (1.1), Qt-Doc, KDOC y fue espec�ficamente dise�ado para ser usado en proyecto que utilizan el conjunto de herramientas Qt de Troll Tech. Al crear incluye gr�ficos de dependencia, diagramas de colaboraci�n y gr�ficos jer�rquicos incluso para programas no documentados. La salida es similar a la de la documentaci�n Qt.


Debian GNU/Linux Reference Guide
Prev Home Next

 
 
  Published under the terms of the GNU General Public License Design by Interspire