Programmierkonventionen - 1 -
Die wichtigsten Bestandteile der Programmierkonventionen fr Java werden hier erlutert. Dies sind:
Schreibweise von Bezeichnern
Einrckkonventionen
Kommentare
Programmierkonventionen - 2 -
EinleitungEinleitungSpielraum bei der Gestaltung der Details
Richtlinien sollen dazu beitragen, da die Programme stets leicht zu verstehen sind.
Lesbarkeit und Wartbarkeit sind wichtig.
Es gibt zwar keinen "korrekten" Programmierstil, aber die folgenden Konventionen haben sich erfolgreich durchgesetzt.
Programmierkonventionen - 3 -
BezeichnerBezeichner -- 11
Bezeichner mssen (bis auf Laufvariablen in Schleifen, usw. ...) aussagekrftig sein.
Negativbeispiele:
public class A ...int B ...
public class Gaius ...int Julius ...
Programmierkonventionen - 4 -
BezeichnerBezeichner -- 22Bei Bezeichnern, die aus mehreren Wortenzusammengesetzt werden, mu der erste Buchstabe eines Wortes jeweils gro geschrieben oder durch "_" getrennt werden.
Beispiele: roemischeZahl, gebeTextEin, gebe_Text_ein
Negativbeispiel: diesisteinschlechterbezeichnerfuereinezahl
Programmierkonventionen - 5 -
BezeichnerBezeichner -- 44
Bezeichner fr Klassennamen mssen mit einem Grobuchstaben beginnen.
Vorsicht bei Bezeichnern, die aus mehr als einem Buchstaben bestehen. Diese knnen zu Konflikten mit von Java als Bezeichner belegten Wrtern fhren.
Programmierkonventionen - 6 -
Einrckung Einrckung -- allgemeinallgemein
Jede Ebene wird um mindestens 1 Leerzeichen eingerckt.
Die Festlegung der Ebenen ist durch die Einrckkonventionen gegeben.
Durch die Einhaltung der Einrckkonventionen wird die Struktur der Programme leichter erfabar.
Programmierkonventionen - 7 -
Einrcken bei KlassenEinrcken bei Klassen
public class Test {
public static void main () {
}
}
Methodendeklaration isteine Ebene tiefer als
die Klassendeklaration.
Die Anweisungen sind Ebene tiefer als die Methodendeklaration
Klammern schleien aufder Ebene der zugeh-
rigen Klassen - oderMethodendeklartion
Klammern schlieen aufder Ebene der zugeh-
rigen Klassen - oderMethodendeklaration
Programmierkonventionen - 8 -
Einrcken bei SchleifenEinrcken bei Schleifen
do {
}while ()
for (){
}
while (){
}
Die Anweisungen in der Schleife sind eineEbene tiefer als die
Identifier fr die Schleife.
Die Anweisungen in der Schleife sind eineEbene tiefer als die
Identifier fr die Schleife.
Klammern sind auf dergleichen Ebene wiedie if-Anweisungen
Klammern sind auf dergleichen Ebene wie die
die Schleife. Identifier fr
Programmierkonventionen - 9 -
Einrcken bei Einrcken bei ifif--AusdrckenAusdrcken
Die Anweisungen sindeine Ebene tiefer alsdie Konstruktoren der
if-Anweisung.
Die Anweisungen sindeine Ebene tiefer alsder Bedingungsteil
if-Anweisung.if {
}else {
}
der
Klammern sind auf dergleichen Ebene wiedie if-Anweisungen
Klammern sind auf dergleichen Ebene wiedie if-Anweisung
Besteht der Teil aus nur einer Anweisung, so fordert die Syntax von Java die Klammern nicht.Um die bersichtlichkeit zu bewahren, knnen die Klammern jedoch stehen!
Programmierkonventionen - 10 -
Kommentare Kommentare -- 11/* steht zu Beginn eines mehrzeiligen Kommentars.
*/ steht am Ende eines mehrzeiligen Kommentars.
Ein Leerzeichen steht nach /* und vor */.
Die Zeilen eines mehrzeiligen Kommentars sollten mit * gekennzeichnet werden.
Beispiel:
/* Dies ist ein* mehrzeiliger* Kommentar*/
Programmierkonventionen - 11 -
Kommentare Kommentare -- 22
Einzeilige Kommentare werden durch // eingeleitet
Das Ende eines einzeiligen Kommentars wird nicht gekennzeichnet.
Beispiel:
// Dies ist ein einzeiliger Kommentar
Programmierkonventionen - 12 -
Kommentare Kommentare -- 33
Fr jede Klasse soll zu Beginn kurz die Funktionalittbeschrieben werden.
Zustzlich soll der Kopfkommentar die Informationen ber den Autor, die Entwicklungsumgebung, sowie das Datum der Erstellung und der letzten nderungenhalten.
Der Kopfkommentar ist auch in den bungen zu erstellen!
Daher ist fr jede Klasse ein Kopfkommentar der folgenden Form zu erstellen:
Programmierkonventionen - 13 -
Kommentare Kommentare -- 44/* Dieses Programm zeigt einen Willkommensgruss* Autor : Antje Nowack* Umgebung : JDK 1.3, Windows 2000* Erstellt : 25.10.2001* Letzte Aenderung: 30.10.2001*/
public class Test{
public static void main (String [] arguments) {
}
}
Programmierkonventionen - 14 -
Kommentare Kommentare -- 55Nur sinnvolle Kommentare sollten eingefgt werden.
Kommentare sollten keine redundante Informationenthalten.
Negativbeispiel:
Kommentar vor dem Quelltext, der kommentiert wird.
Geht aus den Bezeichnern nicht die Aufgabe der bezeichneten Variablen bzw. Parameter hervor, so sollte diese erlutert werden
// weise c die Summe von a und b zuc = a + b;
Programmierkonventionen - 15 -
Kommentare Kommentare -- 66
Kommentare dienen dem Verstndnis (ebenso wie der brige Teil der Programmierrichtlinien) des Programmes. Entsprechend verstndlich sollten die Kommentareverfat sein.
Beispiel:
/* wenn der Rechner nicht benutzt werden kann,* dann soll ausgefhrt werden*/
if (Stromausfall || Stecker_draussen ||Rechner_kaputt || ... ){
}
Programmierkonventionen - 16 -
Zusammenfassung Zusammenfassung -- 11
Programme mssen gut verstndlich sein"Wir programmieren nicht fr uns, sondern fr andereLesbarkeit und WartbarkeitProgrammierkonventionen mssen daher beachtet werdendies gilt auch fr die Vorlesung "Programmierung"
Bezeichnerwahl ist sehr wichtigProgramme leichter verstndlichgeringere Fehlerhufigkeit
Programmierkonventionen - 17 -
Zusammenfassung Zusammenfassung -- 22
Einrckungenhelfen, die bersicht zu behaltendie Struktur des Programmes schneller zu erfassen
Aussagekrftige Kommentarehelfen, schwierige Stellen zu verstehensind sehr wichtig fr die Wartung
EinleitungBezeichner - 1Bezeichner - 2Bezeichner - 4Einrckung - allgemeinEinrcken bei KlassenEinrcken bei SchleifenEinrcken bei if-AusdrckenKommentare - 1Kommentare - 2Kommentare - 3Kommentare - 4Kommentare - 5Kommentare - 6Zusammenfassung - 1Zusammenfassung - 2
