100ct

Hier ein paar Richtlinien für Autoren von Javascript-Bibliotheken bzw. Module, gefunden bei Dean Edwards unter http://dean.edwards.name/weblog/2007/03/rules/, ein sehr interessanter Artikel für alle die sich mit Javascript beschäftigen. Diese Tipps sollte man sich zu Herzen nehmen, um Problemen aus dem Weg zu gehen…

1. Sei unauffällig
Mein HTML möchte sich nicht in deinem Javascript auskennen.

2. Object.prototype ist verboten!
Dieser Punkt ist so wichtig, daß es eine eigene Richtlinie sein sollte. Objekte sind die Grundbausteine der Javascriptfunktionalität, also nicht mit ihnen verwirren.

3. Nicht zuviel erweitern
Je weniger eingebaute Javascript-Objekte man erweitert, desto besser. Versteh mich nicht falsch. Ursprüngliche Javascript-Objekte sind spärlich mit nützlichen Methoden und Du fühlst Dich verpflichtet, ein oder zwei von deinen Selbst hinzuzufügen. Aber „ein oder zwei“ sind nicht genug für einen kreativen (Bibliothek) Programmierer. Stopp! Nur hinzufügen, was du benötigst. Je weniger Du eingebaute Javascript-Objekte erweiterst, desto weniger stößt Du mit anderen Bibliotheken zusammen.

4. Folge den Standards
Als Bibliothek-Schreiber definierst Du Muster des Javascriptcodes. Muster sind Zeichen von Schwäche in Programmiersprachen. Erinnere Dich daran, daß Javascript und das DOM werden fortwährend erweitert werden, wenn du also etwas „regeln wirst“ dann schau Dich erst um, ob dies nicht bereits geregelt worden ist. Betrachte bereits vorhandene Lösungen. Wenn du Standards folgst, dann folge ihnen eng (z.B. einen Parameter in einer forEach Methode nicht überspringen).

5. Oder folge dem Marktführer
Mozilla zeigt den Weg auf im Javascript. Der Schöpfer der Sprache, Brendan Eich, entwickelt sie weiter. Neue Spracheneigenschaften sind in den Mozilla Browsern vor allen anderen vorhanden. Wenn du Spracheigenschaften hinzufügen willst, schau zuerst in den Mozilla Standards. Wenn du beispielsweise ein Array erweitern möchtest, um eine Aufzählungmethode zu erlauben, dann benutze forEach anstelle von each. Wenn du fehlende Spracheneigenschaften zur Verfügung stellen möchtest, dann folge vorhandenen Standards eng (siehe oben).

6. Sei flexibel
Was, wenn ich ein Verhalten ändern möchte, ohne das Quellenprogramm deiner Bibliothek zu ändern? Wie einfach ist das? Nicht einfach genug. Mach es einfacher.

7. Handhabung des Speichers
Menschen kümmern sich um Speicherprobleme. Erledige Deine Arbeit.

8. Beseitigen von Browser Sniffing
Es scheint, daß Browser-Hersteller für immer konkurrieren, indem sie neue Eigenschaften hinzufügen. Als Bibliothekautor, mußt Du mit der neuesten Mode gehen. Es ist nicht gut genug gelegentlich im Ajax zu grasen, Du mußt wirklich jeden Blog lesen, um den nächsten Hack zu finden. Die Browser-Suche kann süchtig machen.

9. Klein ist besser
Javascriptbibliotheken sind in die Jahre gekommen, einige von ihnen treiben jetzt hochrangige Webseiten an. Aber wir alle haben keine 2MBit DSL Anschlüsse. Also die Bibliothek klein halten. Besser sollte eine Baukastenseite zur Verfügung stehen, die mir erlaubt, meine Bibliothek entsprechend meinen Notwendigkeiten effizient einzurichten.

10. Die zehnte Richtlinie
Die gute alte zehnte Richtlinie. Du kannst auf die zehnte Richtlinie immer bauen.
Die zehnte Richtlinie ist: vorhersagbar sein. Ich sollte erraten können, was deine Methoden tun. Und wenn ich nicht weiß, was eine Methode ist, dann sollte ich darauf schließen können.

11. Bonus-Richtlinien
Dokumentation. Ärgerlich aber notwendig.
Je mehr Namensraum man benutzt, desto wahrscheinlicher ist es sich nicht mehr an Deine Telefonnummer erinnern zu können.
Erinnere Dich daran, daß möglicherweise Millionen Leute deinen Code ausführen werden.

Dieser Artikel wurde bei den Social Bookmark Diensten xixxi.de und h00ligan.de getagt.