Registriert seit: 31. Dez 2004
Ort: Stuttgart
4.408 Beiträge
Delphi XE8 Enterprise
|
Re: Welche Techniken zur Source Code Dokumentation nutzt ihr
12. Sep 2008, 08:56
Ich dokumentiere meinen Sourcecode im Sourcecode. Das soll heissen, dass ich aussagekräftige Namen für alles nehme (Komponenten, Variablen, Procedure und Funktionen). Dazu kommt noch eine kurze Beschreibung, was die Funktion oder Procedure macht oben drüber. Dann noch eventuell ein paar Kommentare in den Sourcecode selber, wenn er etwas unübersichtlich wird (z.B. bei verschachtelten IF-Abfragen).
|