Prof. Dr. Pape - Java Programmierrichtlinien - Methodennamen

Deutsch

Namenskonventionen - Methodennamen

Zurück zur Übersicht

Verb verwenden

Regel: Verwende mindestens ein Verb in Präsensform für eine Methode. Das Verb soll möglichst genau beschreiben, was die Methode macht.
Begründung: Damit Quelltexte verständlicher werden.

Beispiel

personSuchen(), loeschen(), produktVerkaufen()

Begründung

Methoden definieren Funktionen eines Programms, in denen etwas getan wird. Diese Aktionen lassen sich sprachlich am besten mit Verben beschreiben.

Es gibt noch folgende Spezialisierung dieser Regel, bei der auch eine Ausnahme gemacht wird, das z.B. Deutsch und Englisch nicht in einer Klasse vermischt werden soll.

Getter/Setter

Regel: Verwende als Verb das englische Präfix get mit einem nachfolgenden Substantiv, wenn eine Methode (ohne Parameter) einen Wert, der durch das Substantiv beschrieben ist, zurückgibt. Bei getter-Methoden mit booleschen Rückgabewert, wird statt get meist is verwendet.
Regel: Verwende als Verb das englische Präfix set mit einem nachfolgenden Substantiv, wenn eine Methode ohne Rückgabewert und mit einem Parameter einen Zustandswert (insbesondere ein Attribut) eines Objekts ändert.
Begründung: Zur Wahrung des Geheimnisprinzips bei der Programmierung.

Beispiel

String getVorname(), void setVorname(String vorname) , boolean isSchaltjahr(), void setSchaltjahr(boolean schaltjahr)

Begründung

Objekt-Attribute sollten nie öffentlich sein, da die resultierenden Programme sonst zu viele direkte Abhängigkeiten haben und damit sehr schnell zu komplex werden sowie Objekt-orientierte Merkmale wie Überschreiben von Methoden nur schwer oder gar nicht anwendbar sind. Stattdessen dürfen Objekt-Attribute immer nur über Methoden geändert werden, um die Komplexität der Programme zu reduzieren. Und diese Regel wird auch gleich wieder eingeschränkt, da das mit dem Geheimnisprinzip sich nicht einfach durch derartige, mechanisch erzeugbare Zugriffsmethoden wahren lässt, sondern oft das Gegenteil erreicht wird. Diese „Java-Beans“ Namenskonventionen sind im Detail noch etwas weitreichender.

Oft wird auch noch add und remove als Präfix für den Zugriff auf 1-n Beziehungen hinzugenommen.