Seminar aus Softwareentwicklung Programmierstil Style Guidelines fr Java

Seminar aus Softwareentwicklung: Programmierstil Style Guidelines für Java und. NET Klaus Lehner 9957635, klu 2@gmx. at

Seminar aus Softwareentwicklung: Programmierstil Style Guidelines für Java und. NET Übersicht n n n Was sind Guidelines? Wozu Guidelines? Allgemeine Formatierung Namenskonventionen Deklarationen Statements Verzweigungen & Schleifen Whitespaces Dokumentation Check. Style Anwendung in der Praxis Klaus Lehner, 9957635, klu 2@gmx. at 2

Seminar aus Softwareentwicklung: Programmierstil Style Guidelines für Java und. NET Was sind Guidelines? n n Unverbindliche Richtlinien, wie Source Code zu schreiben ist, an die man sich halten sollte. Falls man sich an eine Regel nicht hält, soll man dies dokumentieren! Klaus Lehner, 9957635, klu 2@gmx. at 3

Seminar aus Softwareentwicklung: Programmierstil Style Guidelines für Java und. NET Wozu Guidelines? n n Immer mehr Geld fließt in die Wartung von Source Code Fast keine Software wird immer vom Programmierer selbst gewartet Klaus Lehner, 9957635, klu 2@gmx. at 4

Seminar aus Softwareentwicklung: Programmierstil Style Guidelines für Java und. NET Allgemeine Formatierungen n Keine Tabulatoren Keine Pagebreaks Zeilenlänge auf 80 Zeichen beschränken n Function 1 (param 1, param 2, param 3); Zeilenumbruch nach einem Komma total. Sum Zeilenumbruch nach einem Operator Die neue Zeile an den Anfang des Ausdrucks ausrichten = a + b + c + d + e; for (table. No = 0; table. No < max. Table; table. No += table. Step) Klaus Lehner, 9957635, klu 2@gmx. at 5

Seminar aus Softwareentwicklung: Programmierstil Style Guidelines für Java und. NET Namenskonventionen (1) n Syntaktische Namenskonventionen n n Pascal Case Back. Color Camel Case back. Color Uppercase MAXLEN Kein Case Sensitiv!!! Packages / Namespaces . NET Camel Pascal Klassen Pascal Interfaces Pascal; Präfix I Methoden Camel Pascal Felder, Parameter Property Konstanten Klaus Lehner, 9957635, klu 2@gmx. at Java Camel --- Pascal Uppercase Pascal 6

Seminar aus Softwareentwicklung: Programmierstil Style Guidelines für Java und. NET Namenskonventionen (2) n Semantische Namenskonventionen n Englisch verwenden! Keine Abkürzungen Keine verneinten bool‘schen Variablen bool is. Not. Error; : if (!is. Not. Error). . Iteratoren i, j, k, . . . Repräsentation einer Anzahl n. Points, number. Of. Points Initialisierungsmethoden Initialize. Font. Set() Suchmethoden Find. Next() Berechnungsmethoden Compute. Average() Klaus Lehner, 9957635, klu 2@gmx. at 7

Seminar aus Softwareentwicklung: Programmierstil Style Guidelines für Java und. NET Namenskonventionen (3) n n Java. Beans-Konventionen get / set / is public boolean is. Connected() { return connected; } public String get. Name() { return this. name; } Klaus Lehner, 9957635, klu 2@gmx. at public set. Name(String n) { this. name = n; } 8

Seminar aus Softwareentwicklung: Programmierstil Style Guidelines für Java und. NET Deklarationen n Klassen- und Methodendeklarationen n n Nach jeder Methode 1 Zeile freilassen Variablendeklaration n Nur gleichartige Variablen in einer Zeile deklarieren Immer am Anfang eines Blocks Keine äußerliegenden Variablen überdecken Klaus Lehner, 9957635, klu 2@gmx. at Class Foo { int var; void Foo. Meth() { int var; if (keypressed) { int var; : } // if } // Foo. Meth } // Foo 9

Seminar aus Softwareentwicklung: Programmierstil Style Guidelines für Java und. NET Statements n max. 1 Anweisung pro Zeile n n Ausnahme: For-Schleife Zusammengehörende Statements nacheinander schreiben my. Object. message 1(); my. Object. message 2(); counter++; my. Object. message 3(); my. Object. message 1(); my. Object. message 2(); my. Object. message 3(); counter++; n Bei Schleifen und Verzweigungen immer geschwungene Klammern verwenden Klaus Lehner, 9957635, klu 2@gmx. at 10

Seminar aus Softwareentwicklung: Programmierstil Style Guidelines für Java und. NET Verzweigungen if (condition) { statements; } switch (value) { case 1: statements; /* fall through */ if (condition) { statements; } else { statements; } Klaus Lehner, 9957635, klu 2@gmx. at case 2: statements; break; case 3: statements; break; default: statement; break; } 11

Seminar aus Softwareentwicklung: Programmierstil Style Guidelines für Java und. NET Schleifen & try. . . catch for (initialization; condition; update) { statements; } while (condition) { statements; } do { statements; } while (condition); Klaus Lehner, 9957635, klu 2@gmx. at try { statements; } catch (Exception e) { statements; } try { statements; } catch (Exception e) { statements } finally { statements; } 12

Seminar aus Softwareentwicklung: Programmierstil Style Guidelines für Java und. NET Abstände n Leerzeichen zur besseren Lesbarkeit einführen n n vor und nach Operatoren nach Kommas counter=1; grand. Total=invoice. total()+get. Amount. Due(); grand. Total=Discounter. discount(grand. Total, this); counter = 1; grand. Total = invoice. total() + get. Amount. Due(); grand. Total = Discounter. discount(grand. Total, this); Klaus Lehner, 9957635, klu 2@gmx. at 13

Seminar aus Softwareentwicklung: Programmierstil Style Guidelines für Java und. NET Dokumentation „Goldene Regel“ n Source Code, der es nicht wert ist, dokumentiert zu werden, ist es auch nicht wert, geschrieben zu werden. Klaus Lehner, 9957635, klu 2@gmx. at 14

Seminar aus Softwareentwicklung: Programmierstil Style Guidelines für Java und. NET Code Beautifier n Check. Style n n Command Tool JBuilder Plugin „Compiler“, der nach Guideline-Verletzungen sucht www. sourceforge. net n nach „checkstyle“ suchen Klaus Lehner, 9957635, klu 2@gmx. at 15

Seminar aus Softwareentwicklung: Programmierstil Style Guidelines für Java und. NET Praxisbeispiel VAI Linz n n Besprechung festgelegte Regeln für alle jederzeit zugänglich zusätzlicher Einsatz von Check. Style Klaus Lehner, 9957635, klu 2@gmx. at 16

Seminar aus Softwareentwicklung: Programmierstil Style Guidelines für Java und. NET Zusammenfassung n n n Die Richtlinien verstehen Eine Liste von Richtlinien auswählen An diese Richtlinien glauben Sie schon während der Implementierung befolgen, nicht erst nachher Den Style zu einem Teil der Qualität machen Für Menschen, nicht Maschinen programmieren Klaus Lehner, 9957635, klu 2@gmx. at 17

Seminar aus Softwareentwicklung: Programmierstil Style Guidelines für Java und. NET Happy Coding ; -) Klaus Lehner, 9957635, klu 2@gmx. at 18