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 User
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.
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.
Zum Beispiel mit der Extension Doxygen Documentation generation für VS Code
Bitte melde dich an um einen Beitrag zu schreiben. Anmeldung ist kostenlos und dauert nur eine Minute.
Bestehender Account
Schon ein Account bei Google/GoogleMail? Keine Anmeldung erforderlich!
Mit Google-Account einloggen
Mit Google-Account einloggen
Noch kein Account? Hier anmelden.