Dokumentation aller Makros,Abfragen,SQL-Statements einer Access-DB

[Sabse81]

Ich bin derzeit dabei eine Mini-Dokumentation zu einer Access-DB zu erstellen in der Form:

1. Makro_1 (also die Makrobezeichnung)
1.1 Query_1 (Abfragebezeichnung)
   SQL-Script (das entsprichende Script)
1.2 Query_2
   SQL-Script
2. Makro_2
2.1 Query_3
   SQL-Script
usw.

Da das ganze aber relativ viel copy&paste Arbeit darstellt, stelle ich die Frage in die Runde, ob jmd. vielleicht mal etwas ähnliches gemacht bzw. eine Idee hat, wie ich die obige Darstellung mit wenig Aufwand (in Access 2003) erreiche?

Danke und viele Grüße.

[Hondo]

Hallo,
es stellt sich die Frage inwieweit es sinnvoll ist Code extern zu dokumentieren.
Meiner Meinung nach ist es nicht sinnvoll da Code sich ständig verändert und somit die zuletzt erstellte Dokumentation sich schnell überholt.

Wichtig ist es Code direkt in den Modulen zu Dokumentieren. Dazu eignen sich Hilfsmittel wie die MZ-Tools die vordefinierte Prozedurköpfe per Mausklick in eine Prozedur einfügen.
Dabei macht es sinn neben Informationen wie Welche Parameter werden übergeben, welche zurückgegeben, welche globalen Variablen werden verwendet, welche lokalen, welche Prozeduren rufen die zu dokumentierende Prozedur auf, welche Prozeduren werden im Code der Prozedur aufgerufen, etc.
Und vorallem Sinn und Zweck einer Prozedur und was sie macht.

Neben dem Prozedurkopf sollte man aber auch im Code einzelne Codestellen dokumentieren in der Art dass man x-Jahre Später noch weiss warum man das gemacht hat und was man damit bezwecken wollte.
Wenn dann noch jemand eine ausgedruckte Dokumentation möchte kann man auch einfach das Modul ausdrucken.

Dokumentation von Tabellenstruktur sollte z.B. in Form eines ERMs gemacht werden. Eine entsprechende benamsung von Tabellen, Abfragen und Formularen etc. ist dabei auch sehr wichtig - noch wichtiger ist die Benamsung im VBA-Code. Variablennamen sollten "Sprechend" sein und einer gewissen konvention folgen. Beispiele dazu findet man im Netz.

Soweit mal ein grober Überblick.
Gruß Andreas

[database]

Hallo,

Obenstehende Empfehlungen von Hondo sind in jedem Fall zu beachten!

Sieh mal in deiner DB unter Extras ....  Analyse ...  Dokumentierer
Vielleicht kannst du damit was anfangen

HTH