www.mikrocontroller.net

Forum: PC-Programmierung Quellcodedokumentation automatisiert


Autor: Icke Muster (Firma: my-solution) (hendi)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Hi ihr da draußen,

ich hab da mal ein Problem, nachdem sich schlecht googlen lässt, 
Forensuche war auch nicht erfolgreich.
Ich möchte die Quelltextdokumentation von C-Quellcode halbautomatisch 
umsetzen. Ich suche ein Tool, dass von Funktion zu Funktion springt und 
mir die Möglichkeit bietet an dieser Stelle die spezifischen Tags (z.b 
für Doxygen) einzusetzen und zu erläutern. Es sollte am besten gleich 
eine Auswahl an Tags anbieten, oder es zulassen diese selbst zu 
definieren.
Es gibt bei uns viele Programme, die nicht, oder schlecht dokumentiert 
sind. Mit den genannten Tags hat bisher keiner wirklich gearbeitet. Nun 
hab ich keine Lust überall hin zu scrollen und das alles von Hand zu 
manipulieren. Ich kenne ein derartiges Tool von Netbeans. Dort war das 
eine Erweiterung zu Javadoc, wenn ich mich nich irre.
Wir entwickeln mit der Keil-IDE uVision, deshalb hab ich auch keine Lust 
z.B. in Eclipse ein extra Projekt anzulegen. Falls diese Art der 
Dokumentation mit uVision funktionieren sollte, bitte ich um 
Erläuterung, ansonsten wäre ein standalone-Tool sehr hilfreich.
Ich hoffe das war verständlich, danke schon mal für eure Antworten.

Hendi

Autor: yalu (Gast)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Vorab: Ich keine kein Tool mit den von dir genannten Eigenschaften,
bin aber der Meinung, dass du so etwas gar nicht brauchst.

Das Springen von Funktion zu Funktion kann jeder bessere Texteditor.
Viele haben auch ein Folding-Feature, mit dem man nur noch die
Funktionensköpfe und globale Definitionen zu sehen bekommt. Bei Bedarf
kann man dann die Funktionsrümpfe einzeln auf- und wieder zuklappen.

Meist schreibt man aber die Doygen-Kommentare sowieso nur in die
Header-Files, die typischerweise nur die Funktionsköpfe und ein paar
Deklarationen enthalten. Damit sollte das "Springen" zur jeweils
nächsten Funktion durch eine Cursorbewegung um eine oder zwei Zeilen
nach unten erledigt sein.

Wegen der Tags: Bei Doxygen braucht man im Wesentlichen nur drei
davon: \file, \param und \return. Die kann man aber ganz gut im Kopf
behalten. Die Bereitstellung der Tags in Form eines Menüs nützt auch
nur dann etwas, wenn man die Funktion und Verwendung dieser Tags
bereits kennt. Und dann hat man sie wahrscheinlich schneller
eingetippt als in einem 134 Einträge umfassenden Menü gesucht.

Die meiste Arbeit wird darin bestehen, die Funktion der einzelnen
Programmteile zu verstehen und eine Beschreibung dazu zu formulieren.
Diese Aufgabe lässt sich aber leider (noch) nicht automatisieren.

Das ist meine persönliche, subjektive Meinung ;-)

Autor: StinkyWinky (Gast)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Mit einem makro-fähigen Editor sollte es gar möglich sein, die 
Funktionsköpfe samt den \param und \return Einträgen automatisch zu 
erstellen.
Ich habe das unter Delphi mit GExperts schon mal für ein Projekt 
gemacht.

Allerdings war das die kleinste Arbeit, wie yalu schon angedeutet hat.

Autor: Icke Muster (Firma: my-solution) (hendi)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Hm, so hab ich das noch nicht betrachtet. Stimmt, die Doku in den 
headern macht eigentlich auch mehr Sinn, ich bin immer davon 
ausgegangen, dass alles als Quelle vorliegt. Na gut, dann werde ich mir 
darüber noch mal kurz Gedanken machen und mich damit auseinander setzen. 
Danke für eure Hinweise.

Antwort schreiben

Die Angabe einer E-Mail-Adresse ist freiwillig. Wenn Sie automatisch per E-Mail über Antworten auf Ihren Beitrag informiert werden möchten, melden Sie sich bitte an.

Wichtige Regeln - erst lesen, dann posten!

  • Groß- und Kleinschreibung verwenden
  • Längeren Sourcecode nicht im Text einfügen, sondern als Dateianhang

Formatierung (mehr Informationen...)

  • [c]C-Code[/c]
  • [avrasm]AVR-Assembler-Code[/avrasm]
  • [code]Code in anderen Sprachen, ASCII-Zeichnungen[/code]
  • [math]Formel in LaTeX-Syntax[/math]
  • [[Titel]] - Link zu Artikel
  • Verweis auf anderen Beitrag einfügen: Rechtsklick auf Beitragstitel,
    "Adresse kopieren", und in den Text einfügen




Bild automatisch verkleinern, falls nötig
Bitte das JPG-Format nur für Fotos und Scans verwenden!
Zeichnungen und Screenshots im PNG- oder
GIF-Format hochladen. Siehe Bildformate.
Hinweis: der ursprüngliche Beitrag ist mehr als 6 Monate alt.
Bitte hier nur auf die ursprüngliche Frage antworten,
für neue Fragen einen neuen Beitrag erstellen.

Mit dem Abschicken bestätigst du, die Nutzungsbedingungen anzuerkennen.