Programmierstil

Zum Sprechen einer Sprache gerhört es zunächst, dass man die Wörter der jeweiligen Sprache kennt (z.B. Trinken, Durst, Saft, Wein, möchten, ich). Des Weiteren muss man diese Wörter zu sinnvollen Sätzen zusammenfügen (z.B. Ich möchte Saft trinken). Schließlich braucht man, um in einer Gesellschaft Fuß zu fassen, auch einen angepassten Stil (z.B. Hätten Sie vielleicht ein Glas Saft für mich?). Erst wenn sie alle Ebenen beherrschen, kommen Sie in einer Gesellschaft gut zurecht.

Ähnlich verhält es sich mit einer Programmiersprache. Sie lernen die Syntax (z.B. while, printf, fopen), befassen sich mit Programmiertechniken (z.B. Sortieralgorithmen, Umgang mit Dateien) und gewöhnen sich einen guten Programmierstil an (siehe unten).

Wozu brauche ich einen guten Programmierstil? Reicht es nicht, wenn es funktioniert?

Bei kleinen Progrämmchen, in die Sie später nie wieder hinein schauen, kämen Sie so ziehmlcih ohne einen besonderen Programmierstil aus. In großen Softwareprojekten sieht das ganz anders aus. Sie müssen nach Jahren noch Ihren Code verstehen, andere wollen ihn schnell nachvollziehen können, und Ihr Programm ist nur ein kleiner Teil eines großen Projektes. Damit solche Projekte überhaupt Funktionieren, und das möglichst unter Vermeidung unnötiger Probleme, müssen Sie sich einen Guten Programmierstil angewöhnen.

Also, los gehts:

Einrückung und Kommentare

• Verwenden Sie eine sinnvolle Einrückung von Programmzeilen. Siehe hierzu ein Musterprogramm und die Erläuterungen zum Einrücken.
• Nutzen Sie sinnvolle Kommentare in Ihrem Programm. Siehe hierzu wieder das Musterprogramm und die Erläuterungen zu Kommentaren.

Erscheinungsbild

• Vermeiden Sie lange Zeilen. Die Zeilen Ihrer Programme sollten beim Ausdruck inkl. Einrückung auf ein Blatt Papier im Protrait-Format passen.
• Vermeiden Sie lange Ausdrücke. Lange Ausdrücke sollten aufgeteilt werden.
• Schreiben Sie nie mehr als einen Ausdruck pro Zeile. Anders ausgedrückt: Nur ein Semikolon pro Zeile! (Einzige Ausnahme ist die for-Schleife.)
• Nutzen Sie Klammen, um Ihren Code besser lesbar zu machen. Auch wenn die Reihenfolge der Bearbetung von Operatoren durch die Rangfolge eindeutig geregelt ist, kann es sinnvoll sein, hier und da eine Klammer zu spendieren.
• Verwenden Sie Leerzeichen zur besseren Lesbarkeit. Beispiele:
  

  statt	besser
  a=b+c;	a = b + c;
  for(i=0;i<5;i++){	for(i=0; i<5; i++) {
  int a,b,c[4]={1,2,3,4};	int a, b, c[4] = { 1, 2, 3, 4 };

Namensvergabe

• Verwenden Sie aussagekräftige Namen. Vermeiden Sie trotzdem sehr lange Namen, da diese in längeren Ausdrücken für die Lesbarkeit hinderlich sind.
• Alle Makros, die Sie mit #define festlegen, werden mit Großbuchstaben geschreiben. Beispiel:
  #define VEKTOR_GROESSE 100
• Legen Sie sich in Ihrem Programm auf eine Sprache fest. Am besten gewöhnen Sie sich gleich Englisch als Sprache für eingene Variablen, Funktionen, Kommentare etc. an. Sie können sich aber auch für eine andere Sprache entscheiden. In diesem Praktikum gilt: verwenden Sie deutsch oder englisch, aber entscheiden Sie sich für eine der beiden.
• Bei der Verwendung von zusammengesetzten Namen gibt es zwei Möglichkeiten: Entweder Sie trennen die Teilnamen durch Tiefstriche (z.B. array_size) oder Sie nutzen Großbuchstaben (z.B. ArraySize oder arraySize). Bei Makros müssen in jedem Fall die Trennungen mit Tiefstrichen erfolgen.

Programmstruktur

• Globale Variablen sollen komplett vermieden werden. Ausnahmen sind nur in speziellen Situationen erlaubt. Die Kommunikation zwischen Funktionen erfolgt über Argumente/Parameter und Rückgabewerte.
• Die Definition von Variablen erfolgt so lokal wie möglich. Dadurch lassen sich Fehler vermeiden.
• Ein Programm erhält folgenden Aufbau:
  1. #include-Anweisungen
  2. Typendefinitionen und #define-Anweisungen
  3. Deklarationen von Funktionen (mit Semikolon am Zeilenende)
  4. Das Hauptprogramm main
  5. Definition der Funktionen (mit Rumpf)
• Die Länge einer Funktion sollte weder unnötig kurz, noch unleserlich lang sein.

Interaktion mit dem Benutzer

• Sprechen Sie mit dem Benutzer! Teilen Sie dem Benutzer durch sinnvolle Ausgaben mit, was das Programm gerade macht.
• Die Sonderzeichen sollen korrekt ausgegeben werden. In unserer Umgebung wird die Code-Seite 850 verwendet. Hier einige Sonderzeichen:

  Zeichen	Hex-Code	Oktal-Code
  Ä	8E	216
  Ö	99	231
  Ü	9A	232
  ä	84	204
  ö	94	224
  ü	81	201
  ß	E1	341

• Fangen Sie alle Fehleingaben des Benutzers ab. Sagen Sie ihm, was er falsch gemacht hat. Geben Sie Hinweise auf die korrekte Bedienung Ihres Programms.
• Achten Sie auf eine intuitive und einfache Benutzerführung. Versetzen Sie sich in einen Benutzer, der zum ersten mal Ihr Programm benutzt und wenig Ahnung vom Thema hat. Auch er soll Ihr Progamm mit Spaß und ohne Frust benutzen können.