Dokumentation aber wie?

Status
Nicht offen für weitere Antworten.

battle4ngel

Mitglied
Hi,

ich habe von jemand anderen ein relativ umfangreiches Java Projekt übernommen. Es handelt sich um ein Datenbankprogramm mit GUI etc. allerdings hat mein Vorgänger nach der Devise "Wer dokumentiert ist feige" gearbeitet.
Nachdem ich mich jetzt ca. 1 Monat durch den Code gewühlt habe, Klassen und Methoden kommentiert habe etc. und ein paar Klassendiagramme in UML reverse engineered habe, suche ich nach einer Dokumentationsart, die es mir ermöglicht die genauen Datenbankzugriffe import entscheidungen rollback etc. genauer zu dokumentieren. Ich möchte der Person die später das Projekt übernimmt nicht nocheinmal Codegewühl zumuten.
Gibt es eine Möglichkeit eine art Programablaufplan/Sequenzdiagramm zu machen, in das man noch zusätzliche Kommentare einfügt? Ich habe UML zwar in der FH durchgenommen, allerdings bin ich relativ ratlos welches der x verschiedenen Diagramme ich am besten verwenden kann?


mfG


Marijke
 

Acha

Bekanntes Mitglied
Falls Du als Entwicklungsumgebung Eclipse einsetzt, kann ich Dir dafür das Omondo-plugin empfehlen. Damit kannst Du zumindest per Reverse Engineering UML-Diagramme zu Deinem Code erstellen und mußt das nicht mühsam per Hand.

MFG

Acha
 
Status
Nicht offen für weitere Antworten.
Ähnliche Java Themen
  Titel Forum Antworten Datum
lappenmaster1337 Kann die Dokumentation nicht installieren IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 4
A Javadoc Klassen-Dokumentation wird nicht angezeigt IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 0
T Eclipse JavaFX Dokumentation Standort nicht gefunden IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 11
D IDEA IntelliJ Dokumentation von Libaries einbinden IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 4
J NetBeans Dokumentation anderer Projekte IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 2
J IDEA IntelliJ Java source code und Dokumentation IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 4
G JDK 1.3 Dokumentation IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 4
J Eclipse: Zugriff auf API-Dokumentation einrichten IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 6
T Eclipse Java Projekt funktioniert in Eclipse, aber nach export kein Dateizugriff IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 3
D Crawler funktioniert in intellij aber in Eclipse nicht IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 4
M Eclipse Eclipse startet nicht (lädt aber) IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 4
I Eclipse, Ausklappen mit Stern, aber ohne Outline der Klassen? IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 2
D Eclipse Plugin Entwicklung, aber wie beginnen IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 4
D Eclipse Projekt exportieren , aber bestimmte Verzeichnisse auslassen IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 14
L Programm funktioniert in Eclipse aber nicht in BlueJ IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 3
O Eclipse startet aber nur ein kleines graues Fenster IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 2
S Exception in Eclipse, aber nicht bei normaler Kompilierung IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 5
ven000m Eclipse auf anderen Pc - will aber Workspace behalten. IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 2
P JBuilder exe & co . aber wo IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 3
D Eclipse aber welches IDEs - Eclipse, IntelliJ IDEA, BlueJ & mehr 11

Ähnliche Java Themen

Neue Themen


Oben