<![CDATA[Dokumentationswerkzeuge]]>Hallo,

ich stehe gerade vor der Entscheidung für meinen Quellcode einfach nur per Hand etwas zu kommentieren , dies über ganz normale Kommentare.
Oder aber über doxygen zu arbeiten. Der übersichtlichkeit würde ich eher die normalen Kommentare verwenden.
In wie fern ist es denn sinnvoll dokumentationswerkzeuge zu verwenden? Ich würde so doxygen verwenden weil ich mit Linux unterwegs bin.
Benutzt ihr Dokumentationswerkzeuge? Sollte man das?

Danke

]]>https://www.c-plusplus.net/forum/topic/196349/dokumentationswerkzeugeRSS for NodeTue, 30 Jun 2026 06:39:27 GMTSun, 28 Oct 2007 17:24:08 GMT60<![CDATA[Reply to Dokumentationswerkzeuge on Sun, 28 Oct 2007 17:24:08 GMT]]>Hallo,

ich stehe gerade vor der Entscheidung für meinen Quellcode einfach nur per Hand etwas zu kommentieren , dies über ganz normale Kommentare.
Oder aber über doxygen zu arbeiten. Der übersichtlichkeit würde ich eher die normalen Kommentare verwenden.
In wie fern ist es denn sinnvoll dokumentationswerkzeuge zu verwenden? Ich würde so doxygen verwenden weil ich mit Linux unterwegs bin.
Benutzt ihr Dokumentationswerkzeuge? Sollte man das?

Danke

]]>https://www.c-plusplus.net/forum/post/1393703https://www.c-plusplus.net/forum/post/1393703Sun, 28 Oct 2007 17:24:08 GMT<![CDATA[Reply to Dokumentationswerkzeuge on Sun, 28 Oct 2007 17:32:09 GMT]]>Doxygen ist schon praktisch, da es einem mehr Übersicht verschafft. Man muss aber vermeiden, dass man sinnlose Kommentare einfügt, um offensichtliche Funktionen zu dokumentieren. Ich würde beim Einsatz von Doxygen nicht groß von den normalen Dokumentationsregeln abweichen. Daher gibt es imho kein Übersichtlichkeitsproblem.

"Documentation is like sex when it is good, it is very, very good; and when it is bad, it is better than nothing."
- Dick Brandon
🙂

]]>https://www.c-plusplus.net/forum/post/1393706https://www.c-plusplus.net/forum/post/1393706Sun, 28 Oct 2007 17:32:09 GMT