Delphi-PRAXiS - Inhalt einer Dokumentation?

Delphi-PRAXiS (https://www.delphipraxis.net/forum.php)

- Programmieren allgemein (https://www.delphipraxis.net/40-programmieren-allgemein/)

- - Inhalt einer Dokumentation? (https://www.delphipraxis.net/12780-inhalt-einer-dokumentation.html)

chris_82

3. Dez 2003 23:02

Inhalt einer Dokumentation?

Was gehört in eine ordentliche Dokumentation eines Projektes alles hinein? :gruebel:

Hansa

3. Dez 2003 23:14

Re: Inhalt einer Dokumentation?

Kommentare des Source. Erklärung aller Units (wo was zu finden ist). Ansonsten kommt es drauf an, wie weit das ganze geht.

cyberkiller0072001

18. Jan 2004 16:22

Re: Inhalt einer Dokumentation?

Wichtig ist auch immer eine Erklärung wo drinsteht, welche Variablen für was verwendet wurden...

MfG Daniel :cheers:

Sanchez

18. Jan 2004 17:00

Re: Inhalt einer Dokumentation?

im Optimalfall sind Variablenbezeichnungen weitgehend selbsterklärend. Genauso wie funktionen.
Ich würde da keine komplette Aufstellung der Variablen machen. Der Ablauf im groben sowie ein detaillierter Ablauf der Units und der wichtigsten Funktionen würd ich für angebracht halten.
Außerdem würd ich die GUI näher erläutern.

grüße, daniel

Alle Zeitangaben in WEZ +1. Es ist jetzt 09:18 Uhr.