Dokumentationstool für Embedded Software

[Ralf Neuber]

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

 

[Ruediger Kluge]

Hallo,
Ralf Neuber schrieb:

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.

vielleicht so etwas:
http://www.myfriend.de/index.htm?/ffe.html
freie EDU Version

oder

http://www.easycode.de/docs/de/d_aktuell.htm

--
Gruß
Rüdiger
_____________________________________________________________

E-mail ruediger.kluge@conelek.com
Web http://www.conelek.com/
_____________________________________________________________

 

[Robert Koch]

"Ralf Neuber" <Ralf.Neuber_SCHEISSSPAM@gmx.de> schrieb im Newsbeitrag
news:bvp0ld$u5smv$1@ID-185099.news.uni-berlin.de...

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.

wie wär's mit doxygen? -> www.doxygen.org

Gruß

Robert

 

[Oliver Betz]

Ruediger Kluge <ruediger.kluge@conelek.com> schrieb:

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.

vielleicht so etwas:
http://www.myfriend.de/index.htm?/ffe.html
freie EDU Version

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?

http://www.easycode.de/docs/de/d_aktuell.htm

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

 

[Ralf Neuber]

Hallo!

Habe mir Doxygen heruntergeladen und bin beim Testen.


Ich denke auch, dass das etwa mein Ziel abdeckt.

Danke für alle Antworten!
Ralf

 

[Bernhard Roessmann]

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.

Das simpelste Tool dass ich dafuer kenne ist RoboDoc, schau mal auf
http://www.xs4all.nl/~rfsber/Robo/robodoc.html

Wenn Du ein kleines Makro fuer VisualStudio (6.0 glaube ich war das),
dass nach Markierung von Funktionsnamen und so gleich auf Tastendruck
einen vernuenftigen Header macht, kann ich Dir das mailen.

LG,

--
Bernhard Roessmann
Don't Fear The Penguins!

 

[Ralf Neuber]

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

 

[Georg Acher]

In article <c08iu3$145abq$1@ID-185099.news.uni-berlin.de>,
"Ralf Neuber" <Ralf.Neuber_SCHEISSSPAM@gmx.de> writes:
<doxygen>
|> Ich programmiere embedded, d.h. Interrupts, Assembler sind da eher noch im
|> Fokus als C++, aber ansonsten macht Doxygen seine Sache gut...

Selbst Assembler lässt sich in Doxygen verwurschten Ist zwar nicht mehr ganz
so einfach einzutippen, aber wenns nur ein kleiner Teil in einem grossen
C-Projekt ist, ist das trotzdem nett:

;/**\brief main.asm -- blubb *//*
; *//*! \file
; - Interrupt Table\n
; - Interrupt processing*/ /*
; /*

;*/ /** 8051 standard vector table at 0x00
;*/ vector_table def8051 () {} /*
...
;*/

Evtl. lässt sich da ja auch was mit m4 oder perl automatisch generieren...

--
Georg Acher, acher@in.tum.de
http://wwwbode.in.tum.de/~acher
"Oh no, not again !" The bowl of petunias

 

[Joerg Wunsch]

acher@in.tum.de (Georg Acher) schrieb:

Selbst Assembler lässt sich in Doxygen verwurschten Ist zwar
nicht mehr ganz so einfach einzutippen, aber wenns nur ein kleiner
Teil in einem grossen C-Projekt ist, ist das trotzdem nett:

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