Code-Doku

[Leominora]

Hallo alle miteinander,

hat jemand einen Tip, wie man so etwas aufbaut?

- Namentlich alle Forms und Mods aufführen
- TCP/IP Kopplungen erklären
- Datenbankanbindung
- Typdefinitionen

gehört wo etwas da rein?

Danke für Infos

Leo

[padavan]

geht´s evtl. etwas präziser?

[Leominora]

präziser

ich soll ein Word-Dokument erstellen.
Das Projekt soll von dem Käufer weiterbearbeitet werden können.

Nun wäre meine Frage, was ich da alles dokumentieren muss?

Fange gerade mit Erklären der Pfadstrukturen an...

[padavan]

na der Quellcode für sich gibt doch schon fast alles her was man wissen muss, oder?

Ansonsten doch das übliche:
Pflichtenheft --> was wünscht sich der Auftraggeber
Lastenheft --> wie versteht der Ausführende seine Aufgabe bzw. was wird umgesetzt

[Hansa]

Ich versetze mich mal in die Lage des Käufers und als solcher will ich mit geringem Aufwand am Programm rumpfuschen können. Was würde ich erwarten ?

- was brauche ich außer Delphi noch ?
- selbsterklärende Bezeichner, also kein Button1 und Listbox99
- Dateinamen für Units, die man auch erkennen kann
- deutliche Hinweise auf Gefahren innerhalb des Quelltextes
- ausführliche Kommentare an komplizierten Stellen aber nicht für jedes var i : integer;

dasselbe gilt für die Datenbank : genaue Auflistung der Tabellen usw. Um mehr zu sagen müßte man allerdings mehr über den Einsatzzweck wissen und auch über den Kenntnisstand des Auftraggebers.

[marabu]

Hallo Leo,

es scheint sich nicht um ein "Produkt" zu handeln, sondern um eine Programmierarbeit "im Auftrag". Wenn der Quellcode die wesentliche Leistung darstellt und eine weitere Bearbeitung das eigentliche Interesse des Kunden ist, dann spielen Pflichten- und Lastenheft (Anwendungsqualität) keine Rolle, sondern eher quellenbezogene Qualitäten.

Zu dem was schon geschrieben wurde: Verpasse jeder Funktion eine Beschreibung. Dazu gehören Parameter (Anzahl, Wertebereiche), Rückgabewerte, Benutzungsbeziehungen (wo wird die Funktion aufgerufen, was wird von der Funktion augfgerufen), welche globalen Variablen werden benutzt. Das gleiche für jede Unit: Benutzungsbeziehungen, Reihenfolge der Einbindung, Interface. Ein Verzeichnis aller Konstanten, Typen, Klassen und globalen Variablen wird gebraucht, am besten immer mit Querbezügen.

Das ist immer noch nicht alles, aber hält dich schon in Trab. Wenn es sich um eine Anwendung handelt, dann fehlen auf jeden Fall betriebsbezogene Informationen: FileSystem-Layout, Installation, Deinstallation, Konfiguration, Migration, Datensicherungskonzept, Benutzerverwaltung.

Es gibt Werkzeuge, die dir einen Teil der Arbeit abnehmen können. Ich höre hier mal auf.

Grüße vom marabu

[Leominora]

danke maribu,

ich glaub, damit kann ich wirklich was anfangen!

(Zum Gück ist der Code selbst schon gut dokumentiert, so dass ich das größtenteils nehmen kann.

[Hansa]

Zitat von Leominora:

..Zum Gück ist der Code selbst schon gut dokumentiert...

geht es etwa nicht um eigenen Source ? Dann würde die Lage allerdings völlig anders aussehen !!

[Robert_G]

Zitat von Hansa:

Zitat von Leominora:

..Zum Gück ist der Code selbst schon gut dokumentiert...

geht es etwa nicht um eigenen Source ? Dann würde die Lage allerdings völlig anders aussehen !!

Es geht um eine Doku seiner Sourcen.
Ich weiß nicht wie weit das pasDoc Projekt ist. Als ich es das letzte Mal angeschaut habe war mir Output und Funktionialität noch zu nunja ... gräuselig.
Vielleicht hat sich da ja was getan. Es wird sicher kein so cooler nDoc / jDoc Output werden, aber vielleicht reicht es dir ja?