mikrocontroller.net

Forum: PC Hard- und Software Automatische Code Dokumentation mit Doxygen


Announcement: there is an English version of this forum on EmbDev.net. Posts you create there will be displayed on Mikrocontroller.net and EmbDev.net.
von Michael (Gast)


Bewertung
0 lesenswert
nicht lesenswert
Hallo zusammen,

ich arbeite gerade daran ein source code mit doxygen zu dokumentieren.
Ich hab mich gefragt, ob es ein Tool gibt, welche die Doxygen kommentare 
automatische einfügt?
Bisher habe ich noch nichts interessante gefunden.
Habt Ihr vielleicht so ein Tool?
Oder wie schätz Ihr den aufwand ein solch ein Tool selber zu 
programmieren?

Viele Grüße

: Verschoben durch Moderator
von Michael A. (Gast)


Bewertung
0 lesenswert
nicht lesenswert
Michael schrieb:
> Habt Ihr vielleicht so ein Tool?

Du suchst einen Editor mit Makro-Funktionalität?
Ganz automatisch macht meist wenig Sinn, weil nur du als Programmierer 
weißt, was in der Doxygen Dokumentation auftauchen soll. Sonst wird das 
ein ziemlich hirnloser HTML-Dump.

von Oliver (Gast)


Bewertung
0 lesenswert
nicht lesenswert

von Ppp (Gast)


Bewertung
0 lesenswert
nicht lesenswert
Automatische Kommentare nützen relativ wenig. Da steht nicht mehr drin 
als das, was man selber aus dem Code rauslesen kann. Was fehlt und was 
man in allen Fällen sellber schreiben muss ist die Bedeutung, der Grund, 
etc. warum etwas wie gemacht wird. Macht man das nicht, dann generiert 
einem jedes Werkzeug, ob doxygen oder ein anderes, nur einen Haufen 
Elektronenmüll mit Querverweisen.

von Stephan (Gast)


Bewertung
0 lesenswert
nicht lesenswert
Zum Beispiel mit der Extension Doxygen Documentation generation für VS 
Code

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.