Developer’s Blog

Nun gibt es mal wieder ein bisschen was neues von mir…

Ich habe Doxygen ausprobiert. Das Teil scheint wirklich sinnvoll zu sein. Ich habe - wie viele andere Leute auch - ein Problem mit dem Dokumentieren: Kommentare benutze ich prinzipiell nicht. Ab und zu denke ich dann aber an die Empfehlung aus dem Informatikunterricht, den Code zu kommentieren. So füge ich ab und zu ziemlich willkürlich die eine oder andere Kommentarzeile ein, meistens sogar nur unverständliche oder unnötige Sachen. Und wenn man den Code dann weitergibt, oder ihn sich nach Monaten oder gar Jahren wiedereinmal anschaut, fällt man aus allen Wolken. Und selbst wenn der Code dokumentiert wäre, angenehm wäre es trotzdem nicht, sich den Code anzuschauen, wenn man eigentlich nur wissen will, was diese oder jene Methode oder Klasse tut. Zusätzlich kommt es vor, dass die Kommentare dann extremst verschieden gestaltet sind: Ein Kommentar ist mit ASCII-Zeichen verziert, während der nächste Kommentar nur aus reiner Beschreibung besteht und der eine Kommentar mit einem Doppelslash eingeleitet wird, während ein anderer die Konvention /* … */ nutzt. Schlimm.

Dann habe ich gestern Doxygen ausprobiert und bin vollkommen begeistert. Das hätte ich nie gedacht. Ich habe jetzt einen Plan, wie ich meine Kommentare gestalten muss, und wo ich etwas kommentieren muss. Und das wirklich Tollste ist: Eine Dokumentation wird vollkommen automatisch generiert. Wenn man ordentlich kommentiert, entfällt die komplette Dokumentationsarbeit und die Dokumentation ist immer auf dem aktuellsten Stand: WOW!

Schlagworte: Doxygen

Dieser Beitrag wurde vor am Sonntag, 16. November 2008 um 14:48 Uhr veröffentlicht und unter Allgemeines gespeichert. Sie können Kommentare zu diesem Eintrag über den RSS-2.0-Feed verfolgen. Sie können einen Kommentar hinterlassen oder einen Trackback von Ihrer Website hierher setzen.