Programmiertipps

Einleitung

In diesem Kapitel lernst du einige Tipps kennen, die dir beim Programmieren helfen werden.

Inhalt:
Kommentare in Programmen
Auskommentieren
Klammern und Anführungszeichen
Einrücken
Aussagekräftige Namen

Kommentare in Programmen

Wenn du selbst Programme schreibst, solltest du bei komplizierten Befehlen erklären, was sie genau tun. Am besten schreibt man einen kleinen Kommentar dazu.
Kommentare sind kurze Texte im Code, die nicht interpretiert werden. Einzeilige Kommentare schreibt man so:

//Dies ist ein kurzer Kommentar.

Ein Kommentar über mehrere Zeilen kann mit /* begonnen und mit */ beendet werden.

/* Dies ist ein Kommentar * der über mehrere Zeilen * geht. */

Sinnvolle Kommentare schreiben

Kommentare sollen helfen, das Programm zu verstehen. Dabei sollte man ein paar Grundsätze befolgen:

Nicht das Offensichtliche wiederholen.
pi = 3.14159265358979; //Die Zahl Pi
Sich möglichst kurz halten.
Der Kommentar sollte viel kürzer sein als der Code.
Funktionen und globale Daten immer kommentieren.
/* Gibt eine zufällige ganze Zahl von 1 bis 10 zurück * * Es handelt sich um eine Pseudo-Zufallszahl */ function rand() { var z=Math.random()*10; z = Math.floor(z)+1; return z; }

Auskommentieren

Wenn dein Programm nicht richtig läuft, hilft es manchmal den Code als Kommentar zu markieren ("auskommentieren") und ihn dann wieder Stück für Stück zuzuschalten:
Animation zeigt das Konzept des Auskommentierens

Klammern und Anführungszeichen

Bei vielen Anweisungen werden Klammern gesetzt. Immer wenn eine Klammer geöffnet wird, muss sie auch wieder geschlossen werden; sonst gibt es einen Syntaxfehler. Damit keine Klammern verlorengehen hilft es, wenn man immer gleich auch die schliessende Klammer setzt und dann den Text dazwischen einfügt.

Für Anführungszeichen gilt genau das selbe!
Animation zeigt das effektive Schreiben von Klammern

Einrücken

Code ist einfacher zu lesen, wenn längere zusammengehörende Codeblöcke eingerückt und mit Zeilenabständen getrennt werden.
Der Interpreter wertet die Einrückungen nicht aus.

//Berechnet alle Primzahlen von 2 bis max. i=0; j=0; n=2; prim=true; p=new Array(); //berechnete Primzahlen p[0]=2; max = 100; //obere Grenze for(n=2; n<=max; n++) //n ist die untersuchte Zahl { i=0; prim=true; //es müssen nur die Zahlen bis Wurzel(n) untersucht werden while(p[i]*p[i]<=n) { if(n%p[i]==0) //n ist teilbar durch eine andere Primzahl { prim = false; break; } i++; } if(prim==true) { output(n); p[j++]=n; //n zu den berechneten Primzahle hinzufügen } }

Das Einrücken mit der Tabulatortaste funktioniert im CodeLab mit der Tastenkombination "Alt Tab".

Aussagekräftige Namen

Die Namen von Variablen und Funktionen sollten möglichst kurz, aber dennoch aussagekräftig sein.

Man hat sich auf gewisse Standards für selbstvergebene Namen geeinigt:

Variablennamen werden klein geschrieben.
pi name
Manchmal ist es für die Verständlichkeit gut, wenn auf den Datentyp hingewiesen wird (s=string, n=number, b=boolean etc.).
pi_n name_s
Funktionsnamen beginnen mit einem kleinen Buchstaben, weitere Wörter werden gross geschrieben ("studlyCaps"). Sie sollten auch ein Verb enthalten, das umschreibt, wozu die Funktion im Endeffekt dient.
getSum(); displayResult();