Der Einstieg in diese Technik ist für viele vielleicht etwas schwer. Um in CWEB zu programmieren muß man TeX so einigermaßen beherrschen. Der C, C++ oder Java Code wird bei CWEB mit TeX gemischt. Natürlich kann man das nicht kompilieren. Dafür gibt es zwei Präprozessoren: ctangle und cweave. Die erzeuten die Dokumentation, die Referenzliste und den compilierbaren Quelltext. Der Ertrag ist eine sehr gut strukturierte Dokumentation mit Cross-Referenz über alle Funktionen und deren Aufrufe. Das Ganze ist so aufbereitet, wie man es zu Fuß nicht hinbekommt. Einfach perfekt! Der erzeugte TeX-Code muß noch "geTeXt" werten. Dafür erhält man dvi-Dateien. Und mit dvips erzeugt man schließlich PostScript. Fertig! Sowas verdrahtet man natürlich in einem Makefile.
Sieht zunächst etwas kompliziert aus. Ich weiß aber keine Möglichkeit wie man billiger, schneller und effizienter zu einer wirklich guten Doku kommt. Der Aufwand lohnt sich.
schließen