"Christmas - the time to fix the computers of your loved ones" « Lord Wyrm

Dokumentation für MS Access-Projekt

DKCH 08.12.2004 - 22:21 593 3
Posts

DKCH

...
Registered: Aug 2002
Location: #
Posts: 3280
Hallo,

ich hab das zweifelhafte Vergnügen, für eine über fünf Jahre gewachsene Access-Datenbank die Entwickler-Dokumentation zu aktualisieren (primär für die VBA-Module).

Gibts für Access etwas ähnliches wie zB Javadoc oder so? Oder andere best practices, wie man sowas sinnvoll dokumentiert? Ich steh irgendwie wie der Ochs vorm Tor und weiss nicht, wie ich's angehen soll....

watchout

Legend
undead
Avatar
Registered: Nov 2000
Location: Off the grid.
Posts: 6845
ich kenn zwar kein tool für vb was javadoc ähnelt, aber es wäre vielleicht der ansatz nicht schlecht...
beginne einmal alle funktionen sauber zu dokumentieren, wenn eine funktion besonders interessanten inhalt hat, solltest du diesen genauer beschreiben, sonst sollte aber genauer input/output genügen.
dann machst du nen ablauf, wo du die funktionen/methoden wahrscheinlich gut verwenden können wirst ;)

mat

Administrator
Legends never die
Avatar
Registered: Aug 2003
Location: nö
Posts: 25423
es gibt einige doctools, die angeblich besonders leicht auf andere sprachen portiert werden können. falls ich den link wieder finde poste ich ihn hier.

DKCH

...
Registered: Aug 2002
Location: #
Posts: 3280
Zitat von watchout
ich kenn zwar kein tool für vb was javadoc ähnelt, aber es wäre vielleicht der ansatz nicht schlecht...
beginne einmal alle funktionen sauber zu dokumentieren, wenn eine funktion besonders interessanten inhalt hat, solltest du diesen genauer beschreiben, sonst sollte aber genauer input/output genügen.
dann machst du nen ablauf, wo du die funktionen/methoden wahrscheinlich gut verwenden können wirst ;)

ja, das is schon klar, aber wenn man das dann exportieren & für die weitere doku verwenden kann wärs ja nice. drum auch davor die frage, ob's was gibt, weil's dann gleich mitginge...
Kontakt | Unser Forum | Über overclockers.at | Impressum | Datenschutz