[Xalir]

Erstmal dokumentieren ist nicht modellieren. UML-,Fluß- und Struktogramme gehören in den Bereich der Modellierung.

Den Quellcode zu dokumentieren ist eine Kunst für sich. Zuerst einmal sollte nach Best Practices der Quellcode nur wenig menschliche Dokumentation enthalten, und dafür sich weitesgehend selbst dokumentieren.

In der Regel dokumentiert man nur die Methoden, Funktionen, Eigenschaften und Klassen.

Was bedeutet Selbstdokumentation?

Nun erstmal heißt es sinnvolle Namen für Variablen, Klassen, Objekte usw. zu vergeben.
Anhand eines Programmes wie Kniffel wäre so etwas sinnvoll:

Integer diceOne As Integer;
Integer diceTwo As Integer;
Integer diceThree as Integer;
/ usw...

Dies dagegen wäre eher schlecht und man müsste schon den ersten Kommentar setzen, dass d1 - d6 als Variablen für die Würfel stehen.

Integer d1 As Integer;
Integer d2 As Integer;
Integer d3 As Integer;

Wenn Dich dies genauer interessiert, hier mal [ Link nur für registrierte Mitglieder sichtbar. Bitte einloggen oder neu registrieren ] zu einer Webcastserie, die genau die Probleme anspricht, die man bei der Dokumentation hat. Teil 2 dürfte da sehr interessant sein.