Prof. Dr. Pape - Java Programmierrichtlinien - Bezeichner

Deutsch

Namenskonventionen - Bezeichner

Zurück zur Übersicht

Aussagekräftige Namen wählen

Regel: Verwende für Bezeichner immer aussagekräftige und selbsterklärende Namen.
Regel: Verwende keine Abkürzungen in Bezeichner – schreiben diese Namen immer aus.
Begründung: Quelltexte werden dadurch für alle lesbarer und verständlicher.

Beispiel

Statt KFZ, BA, HS, DB besser Kraftfahrzeug, BundesagenturFuerArbeit, HochschuleKarlsruhe, DeutscheBahn schreiben.

Begründung

Da Quelltexte von vielen unterschiedlichen Programmierern (oft aus unterschiedlichen Kulturbereichen) gelesen und geändert werden, darf man nie davon ausgehen, dass die verwendeten Abkürzungen jedem der beteiligten Personen geläufig sind: BA könnte ja auch Berufsakademie bedeuten oder Bundesangestellter.

Vermische keine verschiedenen Sprachen (nur eine Sprache verwenden)

Regel: Vermische keine verschiedenen Sprachen (Deutsch, Englisch, …) in einer Klasse
Begründung: Quelltexte werden dadurch für alle lesbarer und verständlicher.

Begründung

Diese Regel gilt nicht nur für die Wahl der Sprache der Bezeichner, sondern auch für die Kommentare: Die Bezeichner und Kommentare sollten pro Klasse in genau einer Sprache geschrieben sein. Dadurch muss der Leser nicht immer wieder zwischen den Sprachen wechseln und als Programmierer muss man sich nicht die Mühe machen die Wörter zu übersetzten. Insbesondere letzteres ist bei speziellen Begriffen aus einer Branche schwierig und meist einfach falsch: was heißt zum Beispiel Leistungsreglement in Englisch? oder Warenrechnung?. Normalerweise ist es eine gute Wahl die Sprache zu nehmen, die der Kunde spricht und in der die Anforderungen geschrieben sind. Bei Software, die von Personen aus verschiedenen Ländern programmiert wird, ist allerdings oft Englisch die lingua franca. Ausnahmen von dieser Sprachregel sind die englischen Präfixe für Getter- und Settermethoden (get, set, is) und auch add, remove zum Hinzufügen von Elementen.

Nur alphanumerische Zeichen verwenden

Regel: Verwende ausschließlich die alphanumerischen Zeichen A-Z, a-z, 0-9 und den Unterstrich _ für Bezeichner.
Begründung: Damit die Quelltexte international portabel werden.

Beispiel

Person, zugFahren, MAXIMALE_ANZAHL, ueberpruefen

Begründung

In Java sind zwar alle Unicodealphabete für die Wahl von Bezeichnern zugelassen, aber nicht alle Texteditoren unterstützen jedes Unicode-Alphabet und nicht jeder Java-Quelltext ist in einem Unicodeformat geschrieben. Lediglich der durch den Compiler erzeugte Bytecode ist immer portabel. Des Weiteren werden Paketnamen und Klassennamen mit Dateiordner und Dateien identifiziert: je nach Betriebssystem sind internationale Sonderzeichen dort gar nicht erlaubt. Darüber hinaus gibt es auch kuriose Effekte, wenn z.B. ein Bezeichner mit arabischen Buchstaben geschrieben wird: Arabisch wird von rechts nach links gelesen, die Java Schlüsselwörter sind aber englisch und werden von rechts nach links gelesen. Viele Editoren berücksichtigen dies und wenn man kontinuierlich den Cursor mit der rechten Pfeiltaste bewegt, dann wandert der Cursor bei den englischen Schlüsselwörtern wie erwartet nach rechts, beim Beginn eines arabischen Wortes springt er dann – eigentlich auch wie zu erwarten – an den Anfang des arabischen Wortes. Dies ist aber dann ein Sprung nach Rechts über das ganze Wort. Danach wandert der Cursor bei jedem Druck der rechten Taste nach links bis zum Ende des arabischen Wortes. Versuchen Sie es einfach mal mit dem folgenden Java Bezeichner in Eclipse oder markieren Sie ihn im Browser mit der Maus und bewegen Sie die Markierung hin und her: رمضان (der Fastenmonat im Islam).

Wie das bei Sprachen aussieht, bei denen die Seiten von hinten nach vorne geblättert werden oder die Sätze von unten nach oben geschrieben werden, mag sich jeder selbst ausdenken.

Verwende Upper Case Camel Style

Regel: Bei Bezeichner, die aus mehreren Teilwörtern bestehen, wird der erste Buchstabe jedes Teilworts (ab dem zweiten Teilwort) groß geschrieben, wenn die entsprechenden Wörter normal auseinander geschrieben würden.
Begründung: Damit lange Bezeichner lesbarer sind.

Beispiel

zugFahren, Donaudampfschifffahrt, HochschuleKarlsruhe

Begründung

Diese Regel ist analog zur Grammatik natürlicher Sprachen, die vorschreibt die Wörter eines Satzes mit einem Leerzeichen zu trenne, anstattsiedirekthintereinanderzuschreibenumplatzzusparenoderaus-welchengründenauchimmer.

Im Deutschen kann man im Gegensatz zu vielen anderen Sprachen – wie den romanischen – beliebig lange Substantive bilden (Donaudampfschifffahrtsgesellschaft). Spätestens bei drei Substantiven empfiehlt der Duden einen Bindestrich zu verwenden: Donau-Dampf-Schifffahrts-Gesellschaft würde dann also zu folgendem Java Bezeichner: DonauDampfSchifffahrtsGesellschaft. Das Wort Schifffahrtsgesellschaft wird aber zu Schifffahrtsgesellschaft. Diese Unterscheidung nach Duden für Javabezeichner anzuwenden ist allerdings nicht immer so genau zu nehmen.