Dokumentierst du noch oder codest du schon?

Mittwoch, 14. Mai 2008

Ohne groß zu überlegen würde ich fehlende Dokumentation als Hauptmängel hergestellter Javascript-Quelltexte bezeichnen. In manchen Projekten würde ich gerne alle Mitentwickler in ein Seminar alá „Dokumentieren – Wie, Wann, Warum“ verfrachten. Fragt sich nur, was schlimmer ist – undokumentierter Code oder schlecht/falsch dokumentierter Code.

Gerade habe ich mal wieder so etwas gefunden. Wie soll mir folgende Dokumentation helfen?

/**
 * Does some magic. Expects 2 integer params and returns the correct resultvalue for us
**/

Aah, nun bin ich schlauer… nein, nicht wirklich - wirklich nicht!

Javascript-Entwickler dieser Welt, bitte dokumentiert!

Das ist auch ganz einfach! Haltet euch an die Spezifikationen und erzeugt eine schicke Dokumentation mit dem JSDoc Toolkit. Einen besseren Weg, mich als Freund zu bekommen, gibt es nicht.

Geschrieben von Sascha Hameister in Syntax um 12:00 | Kommentare (0) | Trackbacks (0)

Trackbacks

Trackback für spezifische URI dieses Eintrags

Keine Trackbacks

Kommentare

Ansicht der Kommentare: (Linear | Verschachtelt)

Noch keine Kommentare

Kommentar schreiben

Name
E-Mail
Homepage
Antwort zu
Kommentar	Umschließende Sterne heben ein Wort hervor (wort), per _wort_ kann ein Wort unterstrichen werden. Standard-Text Smilies wie :-) und ;-) werden zu Bildern konvertiert. Um maschinelle und automatische Übertragung von Spamkommentaren zu verhindern, bitte die Zeichenfolge im dargestellten Bild in der Eingabemaske eintragen. Nur wenn die Zeichenfolge richtig eingegeben wurde, kann der Kommentar angenommen werden. Bitte beachten Sie, dass Ihr Browser Cookies unterstützen muss um dieses Verfahren anzuwenden. Hier die Zeichenfolge der Spamschutz-Grafik eintragen:
	Daten merken? Bei Aktualisierung dieser Kommentare benachrichtigen