Re: Source Code Dokumentation mit DocBook

* Stefan Lang <[email protected]> [2004-10-24 10:36]:
> 
> Ich soll den Quellcode für meine Diplomarbeit ausführlich dokumentieren
> und frage mich ob es sich auszahlt das mit DocBook zu erledigen.
> Es handelt sich dabei zur Zeit um ca. 22000 Zeilen in 37 Dateien
> (könnte noch auf max. 35000 Zeilen wachsen).

Das Problem bei Quellcodedokumentation mit DocBook ist, dass Quellcode
und Dokumentation getrennt ist. Erstens muss man die Struktur des
Codes in der Dokumentation duplizieren, zweitens vergisst man bei
Änderungen im Quellcode gerne, die Dokumentation zu ändern.

Ich empfehle daher Doxygen, wo man die Dokumentation in den Quellcode
(z. B. Headerdateien) integrieren kann. Beispiel:

 /**
  * Computes the maximum of the two given numbers.
  *
  * @param a the first number
  * @param b the second number
  * @return the maximum of the two numbers
  */
 int max(int a, int b);

Das ganze funktioniert praktisch genauso wie bei JavaDoc. Als Ausgabe
erhält man HTML, RTF und LaTeX. Aus dem LaTeX-Dokument kann man dann
problemlos PDF generieren. Das ganze funktioniert mit C/C++ und auch
weiteren Sprachen. Bei Java nimmt man ohnehin JavaDoc.


Gruß,
Bernhard

-- 
* Linux Viruscan.....
  Windows 95 found.  Remove it? (y/n)

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.4 (GNU/Linux)

iD8DBQFBe3K/iGU2lt2vZFQRAhiaAKCH23QJUT9PfetsAFqjSq+1pZgUsQCfc/GL
HLoKAz9rX1MYSIZ56VPzQJY=
=UuYj
-----END PGP SIGNATURE-----