Doxygen

Wenn man damit gestraft ist, einen fremden kwelltext verstehen zu wollen oder gar zu müssen, denn empfindet man doxygen als sehr vorteilhaft. Das programm für die automatische erstellung von dokumentazjon aus kommentaren im kwelltext (ähnlich wie javadoc) ist zwar ursprünglich für C, C++ und java gedacht gewesen, eben habe ich es aber probehalber auf ein großes und zudem recht dürftig kommentiertes PHP-projekt (gemeint ist hier bbpress) losgelassen.

Und in der tat, was mir einst aussichtslos schien, ist jetzt möglich geworden: ein verständnis der grundlegenden arbeitsweise in ein paar stunden zu kriegen. Sehr schön ist die HTML-ausgabe von doxygen mit integrierter suchfunkzjon, wenn das ganze über einen webserver mit PHP läuft.

Wer das auch einmal probieren möchte (oder in einem projekt: probieren muss): Für PHP-kwellen hat sich bei mir bewährt, die für C optimierte darstellung auszuwählen, die aufrufgrafen der funkzjonen plotten zu lassen und natürlich alle undokumentierten elemente aufzunehmen. Wenn so wenig dokumentiert ist wie bei bbpress, denn empfiehlt es sich auch, die kwelltexte in die dokumentazjon einzubetten, um wenigstens daraus ein bisschen schlau werden zu können. Wer PHP ganz gut lesen kann, findet in der aufbereitung (natürlich mit syntax-hervorhebung) der generierten dokumentazjon denn alles, was sich sonst nur mühsam erschließen lässt.

Ach so, warum ich in den kwellen von bbpress wühle? Na ja, mir gefällt das kleine forum und ich denke ernsthaft darüber nach, dass ich ein paar beiträge zur weiterentwicklung leiste, wenn ich nächstes jahr den kopf frei genug dafür kriege.

Eine Antwort zu “Doxygen

Kommentar verfassen

Trage deine Daten unten ein oder klicke ein Icon um dich einzuloggen:

WordPress.com-Logo

Du kommentierst mit Deinem WordPress.com-Konto. Abmelden /  Ändern )

Google Foto

Du kommentierst mit Deinem Google-Konto. Abmelden /  Ändern )

Twitter-Bild

Du kommentierst mit Deinem Twitter-Konto. Abmelden /  Ändern )

Facebook-Foto

Du kommentierst mit Deinem Facebook-Konto. Abmelden /  Ändern )

Verbinde mit %s

This site uses Akismet to reduce spam. Learn how your comment data is processed.