13.9.4 Literate Programming
Invece di scrivere codice contenente documentazione, il programmatore letterato
scrive documentazione contenente codice. Questo approccio assicura una buona
documentazione per un programma.
Per saperne di pi� sul literate-programming, vedere Literate Programming.
13.9.4.1 Noweb
Preparazione:
# apt-get install nowebm
Riferimenti per Noweb:
E' uno strumento per il literate-programming simil-WEB, che � pi� semplice, e
fornisce allo stesso tempo estensibilit� e indipendenza dal tipo di linguaggio.
[
72] Quando si invoca
noweb scrive il codice sorgente del programma sui file di output
menzionati nel file noweb, ed un file TeX per la documentazione stampabile.
Il pacchetto Debian ifupdown ne � un raffinato esempio.
$ apt-get source ifupdown
$ cd ifupdown*
$ make ifupdown.pdf ifupdown.ps
13.9.4.2 Doxygen
Preparazione:
# apt-get install doxygen doxygen-doc doxygen-gui
Riferimenti per Doxygen (creato da doxygen!):
Pu� generare documentazione HTML, RTF, pagine di manuale Unix, PostScript, PDF
(usando LaTeX) per C++, C, Java, IDL, e programmi PHP e C# in qualche modo.
Doxygen � compatibile con JavaDoc (1.1), Qt-Doc, KDOC e � stato disegnato
specificatamente per essere usato per i progetti che usano il toolkit Troll
Tech
Qt. Crea i grafici
delle dipendenze di include, diagrammi collaborativi, e grafici di gerarchie di
classi grafiche persino per i programmi non documentati. L'output � simile
alla documentazione di QT.
