myGully.com - Kniffel (Delphi) projekt 'Dokumentation'?

myGully.com (https://mygully.com/index.php)

- Programmierung (https://mygully.com/forumdisplay.php?f=67)

- - Kniffel (Delphi) projekt 'Dokumentation'? (https://mygully.com/showthread.php?t=2182947)

Kniffel (Delphi) projekt 'Dokumentation'?

Guten abend liebe Gulligemeinde;

ich habe ein kleines Problem. ein kleines, zeitlich beschränktes Problem.
Derzeit besuche ich die 12te klasse und habe Informatik Unterricht; das an für sich ist kein Problem.

Wir hatten die letzten zwei Wochen die Aufgabe Spiele in Delphi zu programmieren. :dozey:
Ich und ein paar Freunde, wir haben uns freiwillig für 'Kniffel' gemeldet. Jetzt ist das Programm an und für sich fertig, und es kann an die Präsentation gehen.
Problem nur: Der Lehrer sagte wir sollen den Quelltext durch kommentieren und eine Dokumentation abgeben / vorführen.
Ok, er hat uns mal ein paar blätter über UML ausgegeben; aber die hab ich zugegebener weise nicht mehr.

Jetzt wollte ich bei euch mal fragen ob die grobe Struktur wie ich das als Powerpoint schnell von "EssModel" abgeschrieben habe ok (für Schüler Grundkurs) ist und was ihr vom Programm haltet :rolleyes:

Bitte schaut doch mal über die Powerpoint, ich bin wirklich ratlos.

Programm Hier:
[Link nur für registrierte und freigeschaltete Mitglieder sichtbar. Jetzt registrieren...]

[Link nur für registrierte und freigeschaltete Mitglieder sichtbar. Jetzt registrieren...]

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:

Code:

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.

Code:

Integer d1 As Integer;

Integer d2 As Integer;

Integer d3 As Integer;

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