21. Sep. 2004 (04:00)

Dokumentation ist wichtig

Nun, mit dieser Aussage erz�hle ich euch sicherlich nichts neues. Das hat sich sogar schon unter Programmiererkreisen herumgesprochen. Eine gute Dokumenation zu schreiben ist allerdings aufwendig und manchmal auch schwierig. Wie schwierig, ja geradezu unm�glich es manchmal scheint etwas sinnvolles von sich zu geben habe ich gerade in einem Kommentar innerhalb eines Skriptes entdeckt: // IMPORTANT! // If you change the variable names, this script will NOT // function properly, just change the values. Da soviel Weisheit in diesen Worten steckt bin ich drauf und dran eben diesen Satz von nun an in alle meine selbst getippten Skripte einzubauen. Und wenn ich gerade dabei bin k�nnte ich gleich noch Aufkleber f�r Autos entwerfen: "WICHTIG! Wenn Sie vorne am Motor einen Schlauch durch einen Gieskanne ersetzen wird es wahrscheinlich zu Fehlfunktionen f�hren", oder f�r Farbt�pfe: "ACHTUNG! Wenn sie statt blauer Farbe rote verwenden wird das Ergenis wom�glich vom gew�nschten abweichen.", oder auch f�r Fahrr�der: "GEFAHR! Wenn sie w�hrend der Fahrt die Finger in die Speichen stecken kann das ganz sch�n weh tun!" und nat�rlich f�r Handys: "WICHTIG! Wenn Sie Ihr Mobiltelefon machanisch zerst�ren ist es ziemlich unwarscheinlich dass es noch funktioniert".
gERD Schaufelberger

zur Liste


Aktuelle Artikel