Dokumentationstool für Embedded Software

Feb 03, 2004 4 Replies
R

Hallo!



Ich suche ein möglichst preiswertes Tool, mit welchem die Dokumentationen der Funktionen(Kommentare über Header bzw. Funktion selbst) der einzelnen Module möglichst automatisch in ein Dokument eingezogen werden können.



Dabei sollte die nachträgliche Anpassung der Kommentare möglichst einfach gehalten sein, da der Code schon fertig ist(und an Doku nicht gedacht wurde :-( ).



Was habt ihr im Einsatz + wie zufrieden seit ihr damit?



Was ist ein gutes Tool bei derzeitiger Situation und bei zukünftigen Projekten(wo Doku schon von Anfang an "vorgesehen" ist)



Danke im voraus für Eure Tips! Ralf


Vote
Twitter Facebook LinkedIn
O

Ruediger Kluge schrieb:

wird wohl auch sonst nicht verkauft - der Preis steht da noch mit "1775,80DM", die Screenschots sehen nach Vor-Win32 aus, die "News" beschreiben ein Bonusprogramm aus dem Jahr 2000. Braucht eine Dongle, gips da auch XP-Treiber?

Der OP schrieb "möglichst preiswertes Tool" zur Dokumentation.

Statt einem " Editor zur grafischen Softwareentwicklung in Form von

3-dimensionalen Struktogrammen" empfehle ich ihm dazu ebenfalls Doxygen. Das ist in ein paar Stunden durchschaut und nicht zuletzt deshalb preiswert.

Es wäre zwar einfacher gewesen, sich vorher darüber Gedanken zu machen, aber auch nachträglich kann man damit gut arbeiten. Doxygen sagt selbst, was noch nicht dokumentiert ist. Nutzt man es von Beginn an, ist es praktisch kein Mehraufwand gegenüber normalen Kommentaren. Es ist so weit verbreitet, daß es wohl noch einige Zeit existiert.

Servus

Oliver

Oliver Betz, Muenchen
Vote
Twitter Facebook LinkedIn
R

Hallo!

Habe mir Doxygen heruntergeladen und bin beim Testen.

Ich denke auch, dass das etwa mein Ziel abdeckt.

Danke für alle Antworten! Ralf

Vote
Twitter Facebook LinkedIn
R

Hallo Herr Roessmann!

Hallo!

Habe mir Doxygen heruntergeladen und funktioniert für meine Zwecke recht gut.

Ich programmiere embedded, d.h. Interrupts, Assembler sind da eher noch im Fokus als C++, aber ansonsten macht Doxygen seine Sache gut...

Trotzdem danke für das Angebot + die Antwort! Ralf

Vote
Twitter Facebook LinkedIn
J

snipped-for-privacy@in.tum.de (Georg Acher) schrieb:

Warum nicht Assembler mit C-Präprozessor? Wenn das Ganze in einem Entwicklungspaket passiert, das eigentlich für C-Entwicklung gedacht ist, bietet der Assembler (bzw. der C-Compiler) diese Möglichkeit vielleicht ohnehin. Bei Unix-artigen C-Systemen benennt man die Datei dafür auf .S (großes S) endend.

Jörg Wunsch "Verwende Perl. Shell will man können, dann aber nicht verwenden." Kristian Köhntopp, de.comp.os.unix.misc
Vote
Twitter Facebook LinkedIn

Join the Discussion

Have something to add? Share your thoughts — no account required.

Didn't find your answer?

Ask the community — no account required