Style Guide

Beim Programmieren ist es sinnvoll, gewisse Styleregeln für den Programmcode zu beachten.

• Code wird lesbarer und damit verständlicher
• Anweisungen, Parameter, etc. sind leichter voneinander zu unterscheiden
• Andere können eigenen Code lesen; man kann anderen Code lesen
• Einheitlichkeit fördert Verständlichkeit und Nachvollziehbarkeit

Auto-Format

In Processing immer mal wieder Apfel+T (bzw. Strg+T) drücken, damit der Code automatisch aufgeräumt wird.

Allgemeines

• Ausreichend Leerräume verwenden
• Jede Anweisung in eine eigene Zeile
• Leerzeichen nach jedem Komma und um jeden Operator
  z.B.

line(x, height / 2, 20, y); y = 2 * x;

Namen

• Groß- und Kleinschreibung ist in Processing wichtig
  meinVariablenName und meinvariablenname sind zwei verschiedene Variablen!
• Sketche/Programme fangen mit einem Großbuchstaben an.
• Variablen fangen mit einem Kleinbuchstaben an.
• Für alle zusammengesetzte Namen CamelCase verwenden:
  Also z.B. myNumber, ColoredBall oder bounceFromWall().
• Variablen- und Funktionsnnamen sollten lang genug sein, um ihre Funktion zu beschreiben, also z.B.

int maxLineNumber = 10; void setup() { size(400, 400); } void draw() { int count = 0; while (count < maxLineNumber) { line(count * 10, width, count * 20, 100); } }

• Lokale Variablen können auch mal kurze Namen bekommen:

int i = 0; while (i < 10) { point(x * i, y); i = i + 1; }

Kommentare

• Angemessene, aussagekräftige Kommentare verwenden
• Globale Variablen sollten kommentiert werden
• Jede selbst definierte Funktion mit mindestens einer Zeile erklären.
• (Lieber einmal zu viel kommentieren, als zu wenig)

Blöcke

• Die öffnende geschweifte Klammern in die gleiche Zeile wie der Blockanfang, die schließende geschweifte Klammer in eine eigene.
• Innere Anweisungen (in einem Block) immer einrücken.
  Statt unlesbar so

for (int x=0;x<width;x++) { line(x,mouseY,width/2,height/2);}

den Code also so formatieren:

for (int x = 0; x < widht; x++) { line(x, mouseY, width/2, height/2); }

Funktionen

• Methodennamen sollten mit einem Verb beginnen

void doSomething() { // ... }

• Jede selbst definierte Funktion mit mindestens einer Zeile erklären.
• Die öffnende geschweifte Klammern in die gleiche Zeile wie der Methoden-/Blockanfang, die schließende geschweifte Klammer in eine eigene.

// Berechnet einen Wert int calcValue(int inputValue) { return inputValue * 2; }