Live-Forum - Die aktuellen Beiträge
Datum
Titel
28.03.2024 21:12:36
28.03.2024 18:31:49
Anzeige
Archiv - Navigation
944to948
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
944to948
944to948
Aktuelles Verzeichnis
Verzeichnis Index
Verzeichnis Index
Übersicht Verzeichnisse
Inhaltsverzeichnis

Code-Dokumentation/ -Erklärung

Code-Dokumentation/ -Erklärung
29.01.2008 13:02:30
Jochen
Hi Programmierprofis,
ich habe einige recht umfangreiche Makros erstellt, die nun von einigen Kollegen verwendet und verändert werden sollen. Dazu möchte ich gerne dokumentieren, warum die einzelnen Codeabschnitte so gestaltet sind, wie sie es sind und dabei auch dokumentieren, welcher Arbeitsprozessschritt hinter den jeweiligen Codeabschnitten steht. Hinterher soll die Kombination aus Code und Erklärung selbsterklärend sein.
Gibt es generell eine Empfehlung, wie man sowas macht?
Mir fällt ein:
* direkt im Code Kommentare schreiben
* Code z.B. in Word kopieren und dort kommentieren
* Ablaufbilder z.B. mit Visio, ppt oder sowas
* eine Kombination aus diesen Teilen?
Wäre super, wenn ich hier von euren Erfahrungen profitieren dürfte!
Vielen Dank für eure Hilfe!
Grüße,
Jo

2
Beiträge zum Forumthread
Beiträge zu diesem Forumthread

Betreff
Datum
Anwender
Anzeige
AW: Code-Dokumentation/ -Erklärung
29.01.2008 13:36:11
ransi
HAllo Jo
Schreib mal eine Erklärung wie der Code funktioniert.
Zusätzlich kommentierst du den Code.
Ablaufbilder kann dies Programm erstellen:
Google mal nach "visustin"
Ich denke mit einer Kombination von diesen dreien kommen deine User schon klar...
ransi

AW: Code-Dokumentation/ -Erklärung
29.01.2008 13:58:00
Daniel
Hi
je nach komplexitat und Umfang des Gesamtprojekts kannst du alles verwenden.
Unerlässilch sind meiner Ansich nach kommentarzeilen im Code, einfach weil diese Art der Kommentierung immer vorhanden ist und beim verändern des Kodes gleich mit angepasst werden kann.
Die Gefahr, dass Beschreibung und Code nicht mehr zusammenpassen ist so etwas geringer.
bei den Kommentaren beschränke ich mich meistens darauf, die Codeabschnitte von einander zu trennen und kurz zu beschreiben was in den nächsten 10-20-Zeilen gemacht wird.
eine Detailbeschreibung (mehr Kommentar als Code) ist bei einen leicht verständlichen Aufbau und bei sorgfältig ausgewählten und sprechenden Variablennamen oft nicht erforderlich.
(merke: guter Quellcode ist selbstdokumentierend ;-))
den Kode in Word kommentiern halte ich für überflüssig, das machst du besser im Code selbst.
Wichtiger ist eine Gute Ablaufbeschreibung, ggf. eine Auflistung der verwendeten Variablen (Name, Typ und verwendungszweck).
das kann natürlich auch in Word gemacht werden.
Ablaufdiagramme sind immer gut, um mal ein Grundverständnis für den Ablauf zu bekommen.
die Beschreibung der Teilabschnitte sollten sich im Code in den Kommentarzeilen auch wiederfinden, damit man den leichter den Überblich behält.
Gruß, Daniel
Anzeige

Beliebteste Forumthreads (12 Monate)

Anzeige

Beliebteste Forumthreads (12 Monate)

Anzeige
Anzeige
Anzeige