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 Literate Programming

Anstatt Code zu schreiben, der Dokumentationen enth�lt, schreibt der gebildete Programmierer (literate programmer) Dokumentation die Code enth�lt. Dieser Ansatz sichert eine gute Dokumentation f�r ein Programm.

F�r weitere Informationen zu literate-programming wird auf Literate Programming verwiesen.


13.9.4.1 Noweb

Vorbereitung:

     # apt-get install nowebm

Referenzen f�r Noweb:

Dies ist ein WEB-artiges literate-programming Werkzeug, das einfacher ist, sowie erweiterbar und sprachunabh�ngig. [ 6] Wenn noweb gestartet wird, schreibt es den Programmquellcode in Ausgabedateien, die in der noweb-Datei angegeben sind, und es erstellt eine TeX-Datei f�r die Dokumentation.

Das Debian-Paket ifupdown ist ein gutes Beispiel.

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

13.9.4.2 Doxygen

Vorbereitung:

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

Referenzen f�r Doxygen (von doxygen erstellt!):

Es kann HTML-, RTF-, Unix-Handbuchseiten-, PostScript- und PDF- (durch LaTeX) Dokumentation f�r C++-, C-, Java-, IDL- und zum Teil PHP- sowie C#-Programme erstellen. Doxygen ist kompatibel zu JavaDoc (1.1), Qt-Doc, KDOC und wurde speziell entworfen, um Projekte die Troll Tech's Qt Bibliothek nutzen, zu unterst�tzen. Es erstellt Include-Abh�ngigkeitsdiagramme, Diagramme zu Zusammengeh�rigkeiten und grafische Darstellungen der Klassenhierarchien sogar f�r nicht dokumentierte Programme. Die Ausgabe ist �hnlich zu Qt's Dokumentation.


Debian GNU/Linux Reference Guide
Prev Home Next

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