Programmier-Richtlinien für die Erstellung von Javascript-Programmen

Diese Richtlinien geben ein paar Selbstverständlichkeiten vor, denen ein gutes Programm zu entsprechen hat!

Grundsätzliches zur HTML-Seite

  • http://htmlbasics.wikispaces.com/InfoProgrammierRichtlinien
  • Sie verwenden eine fehlerfreie und den Programmierrichtlinien entsprechende HTML-Vorlage, die den Zeichensatz-Einstellungen Ihres Editors entspricht, so dass auch Sonderzeichen korrekt angezeigt werden. Sie können Ihre Vorlage auf Nachfrage des Lehrers vorzeigen.
    Sie finden solche Vorlagen u.a. auf meiner Javascript-Homepage unter http://javascriptbasics.wikispaces.com.
  • Alle im Unterricht von Ihnen persönlich erstellten Lösungen enthalten das Author-Metatag, Beispiel:
    <meta name="author" content="Anna Lyse">

Grundsätzliches zum Javascript-Quelltext

  • Semicolon am Ende der Zeile verwenden
    • Das ist in jeder anderen Programmiersprache so üblich und das wollen wir hier deshalb auch gleich so machen!
  • Öffnende und schliessende Klammern von Blöcken stehen stets untereinander
    • So sind fehlende Klammern sofort erkennbar!
  • Einrückungen für die bessere Übersichtlichkeit verwenden
    • Wer das nicht tut, wird in der Regel seine Fehler als Letzter finden
    • Der Lehrer wird sich solche Programme auch nicht allzu lange ansehen, ohne Sie darauf hinzuweisen, dass Sie den Quelltext erst einmal lesbar zu schreiben haben!
  • Variablen sinnvoll benennen
    • d.h. bitte mehr als nur einen Buchstaben verwenden! Wir wollen alle den Quelltext verstehen!
  • Kommentare einfügen für das bessere Verständnis
    • sonst wissen Sie selbst vielleicht in drei Wochen schon nicht mehr, was Sie da gemacht haben!
  • Leerzeilen einfügen für eine übersichtlichere Struktur des Quelltextes
  • Falls Sie einen Eindruck davon haben möchten, wie Ihr Quelltext aussehen könnte, dann probieren Sie doch einfach mal einen Beautifier aus:
    z.B. http://jsbeautifier.org/

Konventionen für Dateinamen


Weiterführende Links

Infos für angehende Spezialisten, die es noch etwas genauer wissen möchten!