Dokumentation

Dokumentation ist sehr wichtig, wenn man verstehen will, wie der Code funktioniert. Ich bevorzuge hierzu Inline-Code. Je Datei wird beschrieben, für was die Datei existiert. Dann werden alle Klassen, alle Klassenvariablen sowie alle Funktionen / Methoden ausführlich beschrieben. Dabei gehe ich bei Funktionen / Methoden meist etwas weiter als normalerweise gefordert und beschreibe auch, wie sie ihre Funktionalität realisieren (meist sind die Gedankengänge doch etwas komplizierter). Da mein Code bisher nur in Deutschland eingesetzt wurde, hab ich mich aus Bequemlichkeit darauf beschränkt, alles auf deutsch zu dokumentieren. Ein Fehler, wie sich jetzt rausstellt. Mein PHP-Framework geht wahrscheinlich demnächst nach Indien. Muss ich wohl die Doku überarbeiten.

Also an alle Programmierer da draußen: dokumentiert lieber gleich auf Englisch. Wenn ihr ein wirklich gutes System programmiert, ist die Wahrscheinlichkeit groß, dass es international benutzt werden soll. Die Argumentation, dass sowieso nur ihr das bewusst, ist zu kurzsichtig!

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.