Zum Inhalt springen

Effiziente Dokumentation der Entwicklungen


Antibiotik

Empfohlene Beiträge

Hallo zusammen,

ich habe in unserer Firma folgende Ausgangssituation:

Die Dokumentation der Entwicklungen (Methoden und Klassen im Quellcode, Solutions und Grobarchitektur in Word, etc.) ist nicht sonderlich effizient. Zu einem erfolgt die Dokumentation an unterschiedlichen Stellen (Quellcode, Entwicklungsbeschreibung, …) zum anderen geht sehr viel Zeit für die optische Aufbereitung der Doku drauf. Weiterhin ist die Suche nach gewünschter Information aufgrund der unterschiedlichen Quellen relativ aufwendig.

Habt Ihr Erfahrungen wie die Dokumentation der Entwicklungen vereinfacht werden kann?

Bei uns im Team wurde der Vorschlag gebracht, eine Art Wiki aufzubauen. In diesen Wiki könnten dann automatisch die Kommentare aus dem Quellcode rein fließen, den anderen Teil würden dann die Entwickler verfassen.

Ist dass ein machbarer Weg?

Danke

Ciao

Antibiotik

Link zu diesem Kommentar
Auf anderen Seiten teilen

hi, wir verwenden doxygen,

doxygen wikipedia

ist super praktisch.

die kommentare im quelltext müssen einen bestimmten format aufweisen, der aber sehr einfach ist und leicht zu erlernen ist.

Diese werden dann vom doxygen ausgelesen und automatisch verlinkte htmls generiert. hier ein beispiel so einer automatisch generierten dokumentation:

Xerces-C++: DocumentHandler Class Reference

es lohnt sich, mal genauer rein zu schauen.

gruss

Link zu diesem Kommentar
Auf anderen Seiten teilen

Dein Kommentar

Du kannst jetzt schreiben und Dich später registrieren. Wenn Du ein Konto hast, melde Dich jetzt an, um unter Deinem Benutzernamen zu schreiben.

Gast
Auf dieses Thema antworten...

×   Du hast formatierten Text eingefügt.   Formatierung wiederherstellen

  Nur 75 Emojis sind erlaubt.

×   Dein Link wurde automatisch eingebettet.   Einbetten rückgängig machen und als Link darstellen

×   Dein vorheriger Inhalt wurde wiederhergestellt.   Editor leeren

×   Du kannst Bilder nicht direkt einfügen. Lade Bilder hoch oder lade sie von einer URL.

Fachinformatiker.de, 2024 by SE Internet Services

fidelogo_small.png

Schicke uns eine Nachricht!

Fachinformatiker.de ist die größte IT-Community
rund um Ausbildung, Job, Weiterbildung für IT-Fachkräfte.

Fachinformatiker.de App

Download on the App Store
Get it on Google Play

Kontakt

Hier werben?
Oder sende eine E-Mail an

Social media u. feeds

Jobboard für Fachinformatiker und IT-Fachkräfte

×
×
  • Neu erstellen...