Wie muß ich Quellcode dokumentieren ???

[ravennagilum]

Hallo

will in den Anhang eine Seite Quellcode packen, muß ich den Zeile für Zeile kommentieren oder reicht ein Beschreibungstext ???

Danke

[Rohde]

Ich habe es so gemacht, daß ich jedes meiner Skripte grafisch schön aufbereitet habe, oben beschrieben habe, was das Skript macht (Autor und Datum nicht vergessen) und anschließend jeden Abschnitt noch einmal mit entsprechenden Bemerkungen (Datenbankverbindung aufbauen, SQL-Statement absetzen, Datenbanverbindung schließen, ...) versehen.

Hauptsache Du dokumentierst den Quellcode überhaupt.