Software I Use (11) – Doxygen

Dokumentationen erstellen war schon immer eine Sache die mir relativ wichtig vorkam. Es gibt deutlich mehr als einen Brocken Code auf meiner Platte, den ich vor einiger Zeit mal geschrieben habe, recyceln wollte aber dann doch nicht mehr verstanden habe. Trotzdem hat es einige Zeit gebraucht, bis ich den Dreh mit der Dokumentation raushatte.

Maßgeblich dabei geholfen hat mir Doxygen. Es macht die Pflege von “externen” Dokumentationen zwar nicht unnötig, erlaubt es aber dort zu dokumentieren wo es jedem Programmierer “natürlich” erscheint: Im Quellcode.

Dabei sind die reinen Kommentare zu dem Code weniger spannend als das, was Doxygen darüberhinaus bietet. Jeder kann sich vermutlich denken was eine Methode a la MapEntity::getSpeed() macht, es bräuchte kein Doxygen um das zu erraten.

Aber nicht jeder kann auf den ersten Blick sehen, welche Klassen alle von MapEntity erben und somit in der Spielwelt direkt repräsentiert werden. Ein Blick in die erstelle Dokumentation verschafft dann ganz schnell Klarheit:

Wer erbt hier von wem?

Doxygen geht aber noch weiter und dient mir sogar als Gedankenstütze. Mittels der \todo und \bug Instruktionen kann ich mich selber sehr gut an Dinge erinnern, die ich noch implementieren oder verbessern muss. Oder mich von anderen Leuten daran erinnern lassen.

Hier muss noch poliert werden!

No comments yet.