Programmierstil - IPD Snelting

Programmieren 

Prof. Dr.-Ing. Gregor Snelting 

Dipl.-Inf. Univ. Andreas Lochbihler 

Dipl.-Inform. Denis Lohner 

Universität Karlsruhe 

Institut für Programmstrukturen und Datenorganisation (IPD) 

Lehrstuhl Programmierparadigmen 

WS 2008/2009 

c○2008 by IPD Snelting / Universität Karlsruhe (TH)

Übersicht 

Programmierstil 

1 Programmierstil 

Grundsätzliches 

Namen und Kommentare 

Programmlayout 

Programmstruktur und Lokalität 

Weitere Beispiele . . . 

Allgemeine Programmertipps 

Prof. Dr.-Ing. G. Snelting (Uni Karlsruhe) c○2008 by IPD Snelting – Programmieren WS 2008/2009 2 / 31



Warum verständlich programmieren? 

Warum legen wir Wert darauf, dass Ihre Programme funktionieren, 

und außerdem noch lesbar sind? 

Andere lesen Programme 

Software-Wartung erzeugt 80% der Kosten 

Quelltext ist die einzige verlässliche Dokumentation 

Software wird mit Quelltexten ausgeliefert 

Java Code Conventions (JCC) als internationaler Standard 




Grundregeln 

Halten Sie Ihre Programme 

einfach 

klar 

komplett 

konsistent 

robust 

Preisfrage: Wie erreicht man das? 




Wie schreibe ich ein verständliches Programm? 

Fragen an Ihr Programm: 

Sind Bezeichner aussagekräftig und konsistent gewählt? 

Sind die Komponenten und Verfahren gut dokumentiert? 

Wird die Programm-Struktur durch konsistente Einrückung 

und Leerzeilen verdeutlicht? 

Wird das Verfolgen des Programm-Ablaufs durch kleine, 

wohlstrukturierte Prozeduren unterstützt? 

Ist jede Komponente so lokal wie möglich gewählt? 

Kann das Programm ohne großen Aufwand an veränderte 

Randbedingungen angepasst werden? 




Bezeichner 

Sind die Bezeichner aussagekräftig und konsistent gewählt? 

Selbsterklärende, eindeutige Namen für Methoden und Variablen 

Verwendung einzelner Buchstaben nur als Laufindizes (i, j, k) oder 

Parameter einfacher mathematischer Funktionen (x, y, z) 

Keine weiteren Informationen im Namen kodiert 

Groß/Kleinschreibung (und Unterstriche) zur Trennung von 

Wortteilen 

Einheitliche Groß/Kleinschreibung für Konstanten, Variablen, 

Methoden und Klassen. 


Beispiel 1 



Schlecht: 

public static final int CPL = 80; 

// Characters per line 

oder 

public static final int dfgh = 80; 

// some buffer variable 

Besser: 

public static final int CHARACTERS_PER_LINE = 80; 

Standard: 

String Klasse, beginnend mit Großbuchstaben 

MAX SIZE Konstante, durchgehend groß und mit Unterstrich getrennt 

arraySize Variable, beginnend mit Kleinbuchstaben 

printName Methode, beginnend mit Kleinbuchstaben 


Dokumentation 



Sind die Komponenten und Verfahren gut dokumentiert? 

Kommentiert wird genau das, was nicht offensichtlich ist. 

der Zweck jeder Klasse, Methode und jeder Variable. 

der Zweck von komplizierten Programm-Abschnitten. 

Kommentare geben zusätzliche Informationen. 

Kommentare bereiten vor und erklären nicht nachträglich. 

Kommentare stehen immer vor dem Kommentierten. 

Ausnahme: Kurzkommentare 

Kommentare und Programmtext sind fortlaufend lesbar. 

Kommentare und Programmtext nicht mischen. 

Kommentare sind kurz, präzise und verständlich 


Beispiel 2 



Zweck einer Methode 

/* 

* Return the greatest common divisor of ‘x’ and ‘y’. 

* Use the euclidian algorithm. 

*/ 

public static int gcd(int x, int y) { ... } 

Zweck einer Anweisung 

// recompute the size because the base configuration changed 

actualSize = ... 


Beispiel 3 



Schlecht: 

// check if l is bigger than max 

if (l > max) { 

Gut: 

// space left? 

if (length > maxLength) { 


Beispiel 4 

Schlecht: 



if (first_pointer == begin_of_second) { 

// if first list is empty .. 

Templist [compare] = Mergelist [second_pointer]; 

// take element at the second pointer --> 

// into the Temparray .. 

second_pointer++; 

// .. and move this pointer to next element. 

} //if 

Gut: 

// if first list is empty, move an element 

// from the second list to the temporary. 

if (firstPointer == beginOfSecond) { 

tempList [compare] = mergeList [secondPointer]; 

secondPointer++; 

} 




Einrückung 

Wird die Programm-Struktur durch konsistente Einrückung und Leerzeilen 

verdeutlicht? 

Maximale Breite: 80 Zeichen 

Eine neue Zeile für jeden Befehl 

Absetzen von Strukturen: 

Tiefere Einrückung kontrollierter Befehle (konsistent!) 

Keine übertriebene Einrückung (2–4 Leerzeichen) 

Vor und hinter der Struktur (incl. Kommentar) genau eine Leerzeile. 

Strukturierung von Operatoren und Operanden durch Leerzeichen 

(konsistent!) 

Leerzeilen zwischen Methoden (konsistent!) 


Beispiel 5 



Schlecht: 

while(length++


Beispiel 5 - Auch schlecht 


while ( length < maxLength ) 

{ 

if ( found ) 

// Leave the method if we have 

// found what we searched 

{ 

return; 

} 

} 

else 

// Set found to the result of the call 

// of the check method 

{ 

found = check ( list [ length ] ); 

length = length + 1; 

} 


Beispiel 6 



if (k-i>1) qsort(a, i, k-1, k-i); //sorts the lower list if 

//includes more than 1 

//element 

if (j-k>1) qsort(a, k+1, j, j-k); //sorts the bigger list 

//if includes more than 

//pivot + 1 element 

Besser: 

// sort the left part of the list 

if (pivot - left > 1) { 

qsort(list, left, pivot - 1, pivot - left); 

} 

// sort the right part of the list 

if (right - pivot > 1) { 

qsort(list, pivot + 1, right, right - pivot); 

} 




Überlange Zeilen 

Passt ein Ausdruck nicht auf eine Zeile, 

muss er umgebrochen werden: 

Maximale Breite: 80 Zeichen 

Hinter einem Komma, aber vor Operatoren 

Trenne die äußerste Struktur 

Richte neue Zeile gemäß des umgebenden Ausdrucks aus 

Benutze Addition für überlange Zeichenketten 

Vermeide verwirrende Einrückungen. 


Beispiel 7 



Schlecht: 

longName = longerName + (evenLongerName 

+ alsoLongName) + shortName; 

if ((condition1 && condition2) || 

(condition3 && condition4)) { 

doSomething(); 

Gut: 

longName = longerName 

+ (evenLongerName + alsoLongName) + shortName; 

if ((condition1 && condition2) 

|| (condition3 && condition4)) { 

doSomething(); 




Struktur 

Wird das Verfolgen des Programm-Ablaufs durch kleine, 

wohlstrukturierte Prozeduren unterstützt? 

Grundsatz: 

Was immer in eine eigene Methode ausgelagert werden kann, 

sollte ausgelagert werden: 

Algorithmen 

Methoden zur Realisierung einer Funktion aus der Aufgabenstellung 

Elementare Operationen auf Datenstrukturen 

Mehr als 60 Zeilen in einer Methode? 

⇒ Kann man sie aufteilen? 

(Wenn nicht, kommentieren Sie dieses Problem.) 


Beispiel 8 - Schlecht 



switch (ergebnis.command) { 

case ’a’: //read name,score 

ergebnis.input2 = StdInput.readString(); 

ergebnis._points_ = StdInput.readInt(); 

//wrong input exception: 

if ((ergebnis._points_ >100) || (ergebnis._points_

Beispiel 8 - Gut 



private void readAddition() { 

ergebnis.name = StdInput.readString(); 

ergebnis.score = StdInput.readInt(); 

... 

} 

... 

switch (ergebnis.command) { 

case ’a’: 

// read name and score 

readAddition(); 

break; 




Lokalität 

Ist jede Komponente so lokal wie möglich gewählt? 

Jede Komponente nur verwendbar, wo nötig 

Verwendung von Zugriffsmethoden 

anstelle direkter Zugriffe auf Variablen fremder Klassen. 

(get..., set..., is..., . . . ) 

Definition lokaler Variablen bei Bedarf, nicht “auf Vorrat” 


Beispiel 9 

Schlecht: 



class Sort { 

static int i, j, k; // reserve some variables 

public void sort(...) { 

... 

for (i = 0; i < max; i++) { 

k = list[i]; 

list[i] = list[i + 1]; 

list[i + 1] = k; 

Besser: 

class Sort { 

public void sort(...) { 

... 

for (int i = 0; i < max; i++) { 

int swap = list[i]; 

list[i] = list[i + 1]; 

list[i + 1] = swap; 




Anpassbarkeit 

Kann das Programm ohne großen Aufwand an veränderte 

Randbedingungen angepasst werden? 

Verwendung von Konstanten 

Benutzung von Zugriffsmethoden anstelle direkter Zugriffe auf 

Variablen fremder Klassen 

(get..., set..., is..., . . . ) 

Vermeidung von redundantem Code 

Entscheidend: Struktur Ihres Programmes 




Konstanten 

Wiederkehrende Werte an einer Stelle definiert 

public static final double VAT = 0.19; 

⇒ Änderungen nur an einer Stelle nötig 

Dokumentationswert durch Namen an Verwendungsstelle 

public static final double KM IN A MILE = 1.609; 

... dist = dist * KM IN A MILE; ... 

⇒ Aussagekräftige Namen verwenden! 


Beispiel 10 



Unschön: 

int[] rankings; 

int elements; 

... 

rankings = new int[100]; 

... 

if (elements > 99) { 

System.out.println( 

"Kein Platz mehr! " 

+ "(max. 100)"); 

Besser: 

static final MAX_ELEMENTS = 100; 

int[] rankings; 

int elements; 

... 

rankings = new int[MAX_ELEMENTS]; 

... 

if (elements > MAX_ELEMENTS - 1) { 

System.out.println( 

"Kein Platz mehr! (max. " 

+ MAX_ELEMENTS + " Elemente)"); 


Beispiel 11 

Programmierstil Weitere Beispiele . . . 

Schlecht 

Gut 

if (valid == true) { 

return true; 

} else { 

return false; 

} 

return valid; 


Beispiel 12 

Programmierstil Weitere Beispiele . . . 

Schlecht 

Gut 

if (isFooBar() == false) { 

... 

} 

if (!isFooBar()) { 

... 

} 



Vergleiche bei float und double 


Vorsicht mit Gleitkommazahlen, besonders bei Vergleichen: 

class TestFloat { 

} 

... main(...) { 

foo(1.03, 0.42); 

} 

void foo(float f1, float f2) { 

if (f1 - f2 == 0.61) 

println("Got it!"); 

else 

println("Fail"); 

} 

Ergebnis: Fail 

1.03 − .42 0.6100000000000001 

(Gleitkommafehler) 

⇒ == greift nicht! 

Gefahr bei Berechnungen: 

Aufschaukeln der Gleitkommafehler (→ Numerik) 

Lösung: Test auf Epsilon-Umgebung: 

if (Math.abs(f1 - f2 - 0.61) < 0.000001) ... 




Benutzt die Java API! 

Vorteile von Standardbibliotheken 

Gesparte Arbeit Das Rad nicht immer wieder neu erfinden. 

Expertenwissen Bibliotheken werden oft von Experten geschrieben. 

Schwer zu schlagen ... 

In Java: 

Erprobt Standardbibliotheken häufig verwendet 

⇒ gut getestet 

sehr umfangreiche Standardbibliothek mitgeliefert 

regelmäßig erweitert 

besonders wichtig: 

java.lang 

java.util 

java.io (zum Teil) 




Packages und Import 

Klasse C in anderem Package p definiert 

⇒ mit Import auch in anderem Package verfügbar 

Beispiel: 

Imports am Dateianfang vor Klassendefinition 

import p.C; 

Auch import p.* für alle Klassen von p möglich 

Nachteile: 

mehr Namenskonflikte 

Was wird wirklich benötigt? 

import java.util.LinkedList; 

import java.util.ArrayList; 

import java.io.IOException; 




Allgemeines, in eigener Sache 

Sinn der JCC: Über den Sinn einzelner Regeln der JCC kann man sicher 

diskutieren. Das wird Ihnen auch später im Berufsleben so gehen, 

Firmen verwenden fast immer (eigene) Code Conventions. 

Dennoch: Die JCC sind verbindlich für alle vorgegeben, wir 

bewerten danach! Sie stehen nicht zur Diskussion. 

Die JCC sind auch keine Erfindung von uns, sondern ein 

internationaler Standard. 

Folien und JCC: Auf den Folien wird öfters Code präsentiert, der nicht 

den JCC genügt. 

Das ist keine Rechtfertigung, die JCC in Ihren Programmen 

nicht einzuhalten. Bei Folien ist im Gegensatz zu 

Quellcodedateien der Platz sehr begrenzt.

Programmierstil - IPD Snelting

Erfolgreiche ePaper selbst erstellen

Template löschen?

Als Template speichern?