Programmierrichtlinien

Programmierrichtlinien Version 1.2
WS 03/04, SE121
11.12.2003
RB, CP
Programmierrichtlinien
Version 1.2
1 Codestruktur in JBuilder
1.1 Einstellungen festlegen
Für jedes JBuilderProject kann man individuelle Formatierungsrichtlinien festlegen. Man wählt dazu im Menü Projekt > Projekteigenschaften... -> Reiter Formatierung. Man kann diese Richtlinien auch mit einem Klick auf den Button
„Import...“ importieren. Jedes Teammitglied sollte eine File names „Java Standard.codestyle“ erhalten haben, das
entsprechend zu importieren ist. Im folgenden finden sie Screenshots mit allen Einstellungen. Anhand dieser können die
Coderichtlinien notfalls auch händisch eingestellt werden.
Abb. 1.1
Reiter Allgemein
Abb. 1.2
Reiter Blöcke
1
Programmierrichtlinien Version 1.2
WS 03/04, SE121
Abb. 1.3
Reiter Leerzeichen
Abb. 1.4
Reiter Leerzeilen
11.12.2003
RB, CP
2
Programmierrichtlinien Version 1.2
WS 03/04, SE121
Abb. 1.5
Reiter Umbruch
Abb. 1.6
Reiter Generiert
11.12.2003
RB, CP
3
Programmierrichtlinien Version 1.2
WS 03/04, SE121
Abb. 1.7
11.12.2003
RB, CP
Reiter Importe
2 Allgemeine Coderichtlinien
2.1 Java Code Conventions
Um ineffiziente oder schwer zu wartende Programierkonstrukte zu verhindern, sind die Regeln der Java Code
Conventions zu beachten. Man erhält diese Richtlinien unter http://java.sun.com/docs/codeconv/.
2.2 Dokumentationsrichtlinien
Allgemeines zu Javadoc Kommentare beginnt mit „/**“ und endet mit „*/“. Der Text im Kommentar ist HTML,
womit beliebige HTML tags eingefügt werden können. Der erste Satz sollte immer eine Zusammenfassung dessen sein,
das man kommentiert. Jede Referenz auf ein Codestück sollte in einem <code> tag eingeschlossen sein (z.B. <code>
SearchController</code>). Weiters kann man auf anderen Code einen Link setzen. Dies geschieht mit {@link #entity
label} (z.B. @link SearchController SearchController object} ).
Am Ende des Kommentars können spezielle Tags stehen, die alle mit @ beginnen und jeweils in einer eigenen Zeile
stehen müssen.
2.2.1 Klassen und Interfaces dokumentieren
Jede Klasse hat zu Beginn ein Javadoc Kommentar zu enthalten. Zu Beginn steht eine kurze Beschreibung der Klasse.
Danach folgen Angaben über Author, Version und Änderungshistorie
4