Die Präsentation wird geladen. Bitte warten

Die Präsentation wird geladen. Bitte warten

Style Guidelines für Java und.NET Klaus Lehner 9957635, Seminar aus Softwareentwicklung: Programmierstil.

Ähnliche Präsentationen


Präsentation zum Thema: "Style Guidelines für Java und.NET Klaus Lehner 9957635, Seminar aus Softwareentwicklung: Programmierstil."—  Präsentation transkript:

1 Style Guidelines für Java und.NET Klaus Lehner , Seminar aus Softwareentwicklung: Programmierstil

2 Style Guidelines für Java und.NET Klaus Lehner, , 2 / 18 Übersicht Was sind Guidelines? Wozu Guidelines? Allgemeine Formatierung Namenskonventionen Deklarationen Statements Verzweigungen & Schleifen Whitespaces Dokumentation CheckStyle Anwendung in der Praxis

3 Seminar aus Softwareentwicklung: ProgrammierstilStyle Guidelines für Java und.NET Klaus Lehner, , 3 / 18 Was sind Guidelines? 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!

4 Seminar aus Softwareentwicklung: ProgrammierstilStyle Guidelines für Java und.NET Klaus Lehner, , 4 / 18 Wozu Guidelines? Immer mehr Geld fließt in die Wartung von Source Code Fast keine Software wird immer vom Programmierer selbst gewartet

5 Seminar aus Softwareentwicklung: ProgrammierstilStyle Guidelines für Java und.NET Klaus Lehner, , 5 / 18 Allgemeine Formatierungen Keine Tabulatoren Keine Pagebreaks Zeilenlänge auf 80 Zeichen beschränken Zeilenumbruch nach einem Komma Zeilenumbruch nach einem Operator Die neue Zeile an den Anfang des Ausdrucks ausrichten Function1 (param1, param2, param3); for (tableNo = 0; tableNo < maxTable; tableNo += tableStep) totalSum = a + b + c + d + e;

6 Seminar aus Softwareentwicklung: ProgrammierstilStyle Guidelines für Java und.NET Klaus Lehner, , 6 / 18 Namenskonventionen (1) Syntaktische Namenskonventionen Pascal Case BackColor Camel Case backColor Uppercase MAXLEN Kein Case Sensitiv!!! Java.NET Packages / Namespaces CamelPascal Klassen Pascal Interfaces PascalPascal; Präfix I Methoden CamelPascal Felder, Parameter Camel Property ---Pascal Konstanten UppercasePascal

7 Seminar aus Softwareentwicklung: ProgrammierstilStyle Guidelines für Java und.NET Klaus Lehner, , 7 / 18 Namenskonventionen (2) Semantische Namenskonventionen Englisch verwenden! Keine Abkürzungen Keine verneinten boolschen Variablen Iteratoreni, j, k,... Repräsentation einer AnzahlnPoints, numberOfPoints InitialisierungsmethodenInitializeFontSet() SuchmethodenFindNext() BerechnungsmethodenComputeAverage() bool isNotError; : if (!isNotError)..

8 Seminar aus Softwareentwicklung: ProgrammierstilStyle Guidelines für Java und.NET Klaus Lehner, , 8 / 18 Namenskonventionen (3) JavaBeans-Konventionen get / set / is public boolean isConnected() { return connected; } public setName(String n) { this.name = n; } public String getName() { return this.name; }

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

10 Seminar aus Softwareentwicklung: ProgrammierstilStyle Guidelines für Java und.NET Klaus Lehner, , 10 / 18 Statements max. 1 Anweisung pro Zeile Ausnahme: For-Schleife Zusammengehörende Statements nacheinander schreiben Bei Schleifen und Verzweigungen immer geschwungene Klammern verwenden myObject.message1(); myObject.message2(); counter++; myObject.message3(); myObject.message1(); myObject.message2(); myObject.message3(); counter++;

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

12 Seminar aus Softwareentwicklung: ProgrammierstilStyle Guidelines für Java und.NET Klaus Lehner, , 12 / 18 Schleifen & try...catch while (condition) { statements; } try { statements; } catch (Exception e) { statements; } try { statements; } catch (Exception e) { statements } finally { statements; } for (initialization; condition; update) { statements; } do { statements; } while (condition);

13 Seminar aus Softwareentwicklung: ProgrammierstilStyle Guidelines für Java und.NET Klaus Lehner, , 13 / 18 Abstände Leerzeichen zur besseren Lesbarkeit einführen vor und nach Operatoren nach Kommas counter=1; grandTotal=invoice.total()+getAmountDue(); grandTotal=Discounter.discount(grandTotal,this); counter = 1; grandTotal = invoice.total() + getAmountDue(); grandTotal = Discounter.discount(grandTotal, this);

14 Seminar aus Softwareentwicklung: ProgrammierstilStyle Guidelines für Java und.NET Klaus Lehner, , 14 / 18 Dokumentation Goldene Regel Source Code, der es nicht wert ist, dokumentiert zu werden, ist es auch nicht wert, geschrieben zu werden.

15 Seminar aus Softwareentwicklung: ProgrammierstilStyle Guidelines für Java und.NET Klaus Lehner, , 15 / 18 Code Beautifier CheckStyle Command Tool JBuilder Plugin Compiler, der nach Guideline-Verletzungen sucht nach checkstyle suchen

16 Seminar aus Softwareentwicklung: ProgrammierstilStyle Guidelines für Java und.NET Klaus Lehner, , 16 / 18 Praxisbeispiel VAI Linz Besprechung festgelegte Regeln für alle jederzeit zugänglich zusätzlicher Einsatz von CheckStyle

17 Seminar aus Softwareentwicklung: ProgrammierstilStyle Guidelines für Java und.NET Klaus Lehner, , 17 / 18 Zusammenfassung 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

18 Seminar aus Softwareentwicklung: ProgrammierstilStyle Guidelines für Java und.NET Klaus Lehner, , 18 / 18 Happy Coding ;-)


Herunterladen ppt "Style Guidelines für Java und.NET Klaus Lehner 9957635, Seminar aus Softwareentwicklung: Programmierstil."

Ähnliche Präsentationen


Google-Anzeigen