Live-Forum - Die aktuellen Beiträge
Anzeige
Archiv - Navigation
1828to1832
Aktuelles Verzeichnis
Verzeichnis Index
Übersicht Verzeichnisse
Vorheriger Thread
Rückwärts Blättern
Nächster Thread
Vorwärts blättern
Anzeige
HERBERS
Excel-Forum (Archiv)
20+ Jahre Excel-Kompetenz: Von Anwendern, für Anwender
Inhaltsverzeichnis

Dokumentation zum VBA Code

Dokumentation zum VBA Code
28.04.2021 15:44:39
Gerald
Hallo zusammen,
ich habe ein umfangreiches Berichtstool in VBA für unsere Firma entwickelt. Vieles hier mit eurer Hilfe.
Da ich das Unternehmen nun bald verlasse, wollte ich für meinen Nachfolger eine Dokumentation oder so eine Art Programmablauf erstellen.
Damit er weiß wo passiert was im Code.
Also welche Schritte durchlaufen die einzelnen Module und Userforms, wo führen die einzelnen Sprungmarken hin im Code.
Gibt es da was mit Bordmitteln? Oder gibt es ein anderes Programm was so etwas kann?
Alles händisch durchzugehen ist bei der Menge an Code doch sehr mühsam.
Würde mich über eine Antwort freuen.
Gruß

5
Beiträge zum Forumthread
Beiträge zu diesem Forumthread

Betreff
Datum
Anwender
Anzeige
AW: Dokumentation zum VBA Code
28.04.2021 16:12:32
EtoPHG
Hallo,
Über eine (interne) Dokumentation des Codes sollte man sich halt schon während der Entwicklung Gedanken machen, bzw. an wichtigen Stellen 'Kommentare in den Code einbauen. Mir ist kein Tool bekannt, das VBA Code wenigstens rudimentär dokumentieren könnte.
Dir bleibt als nur der mühsame Umweg es manuell zu machen.
Nutze dazu die Debug Funktionen des VB Editor mit dem du nicht nur im Einzelschritt Modus (F8) nutzen kannst, sondern auch dir schon bekannte (bzw. bereits nach-dokumentierte) Subs oder Funktionen mit Prozedurschritt (Shift-F8) und Prozedur abschliessen (Ctrl-Shift-F8) 'überspringen' kannst.
Gruess Hansueli
Anzeige
AW: Dokumentation zum VBA Code
28.04.2021 16:17:13
Gerald
Danke für Deine Antwort.
Kommentare in den einzelnen Modulen hatte ich bereits eingefügt.
Wenn es da nix gibt, dann bleibt mir nur der mühsame Weg.
Gruß
Gerald
AW: Dokumentation zum VBA Code
28.04.2021 16:44:24
ChrisL
Hi
Ich teile die Antwort von Hansueli.
Ergänzend:
Es geht auch nicht nur darum den Code zu dokumentieren, sondern diesen bereits in einer übersichtlichen Struktur zu erstellen (z.B. Vermeidung von Sprungmarken, aussagekräftige Bezeichnungen von Prozeduren, Variablen etc.).
Im Netz wird öfters mal auf die kostenpflichtigen Tools von Aivosto verwiesen (ich habe damit keine Erfahrung). Allerdings würde ich annehmen, dass z.B. ein Ablaufdiagramm am Schluss vom Tag auch nicht sehr viel nützt (entweder kann dein Nachfolger VBA oder eben nicht). Ich denke u.U. erreichst du günstiger Mehrwert, wenn du dich auf die wichtigsten Zusammenhänge konzentrierst und diese manuell dokumentierst. Ausserdem könnte eine kurze DAU-Anweisungen für bevorstehende Änderungen helfen z.B. was ist zu tun, wenn der Dateipfad ändert, was wenn ein neuer Listeneintrag hinzugefügt werden muss usw.
cu
Chris
Anzeige
AW: Dokumentation zum VBA Code
28.04.2021 16:56:25
Gerald
Dankeschön
Dokumentation zum oder des VBA-Code bzw ...
28.04.2021 18:36:23
Luc:-?
…seiner Besonderheiten, Gerald?
1. Regel: Kommentare im oder zum (voran- bzw nachgestellt) Pgm verwenden! Dabei auch intern verwendete andere Pgmm und globale Konstanten inkl eigene Enumerationen und in Mappe bzw ihren Blättern definierte Namen aufführen, sofern sie im Pgm benutzt wdn!
2. Regel: Sinnvolle Einrückungen benutzen!
3. Regel: Pgm so aufbauen, dass es leicht aktualisiert wdn kann! Dazu gehört, dass man alles, was sich an Variablen ändern könnte, aber zZ feststeht, mit Konstanten belegt (mit Const am PgmAnfang deklariert) und im Pgm nur deren Namen benutzt. Das gilt auch für AdressTexte in Range, wobei diese allerdings auch in der Mappe unter definierten Namen angelegt wdn können, was allerdings auch für andere Konstanten zuträfe (kommt Nicht-VBA-Kundigen entgegen).
Je nachdem, was alles dokumentiert wdn soll, reicht es ggf schon aus, die Kommentare auszulesen, wofür bei Verweis auf Microsoft Visual Basic for Applications Extensibility 5.3 benötigte Befehle zu finden sind. Damit könnte man auch gezielt nach SprungMarken, Call-Befehlen u.a. suchen. Das könnte dann schon mal einen (ggf auch tabellierten) RohText für die Doku liefern. Ich hatte so etwas vor Jahren mal gemacht, um ggseitige Abhängigkeiten von Pgmm festzustellen.
Gruß, Luc :-?
„Der beste Beweis für intelligentes Leben im Universum ist, dass noch niemand versucht hat, Kontakt mit uns aufzunehmen.“ H.Lesch, 2018, Sonneberg
Anzeige

Links zu Excel-Dialogen

Beliebteste Forumthreads (12 Monate)

Anzeige

Beliebteste Forumthreads (12 Monate)

Anzeige
Anzeige
Anzeige