15 Jul, 2018

Sauberen Code schreiben – Benennung (Clean Code)

Hi, heute soll es um „sauberen“ Code (Clean Code) gehen. Sauberen Code macht aus, dass er übersichtlich und leicht verständlich ist. Die Benennung spielt hierbei eine entscheidende Rolle.  Doch wie soll diese aussehen? Die folgenden Regeln werden dir bei der Beantwortung dieser Frage helfen.

 

Allgemeine Benennung

Englisch verwenden

Ich empfehle dir deine Variablen, Methode, Klassen, etc. immer in Englisch zu benennen. Dies hilft einerseits deinen Code einheitlich zu gestalten und auf der anderen Seite verbessert es die Zusammenarbeit mit internationalen Entwicklern.

 

Funktion offenlegen

Der Name sollte immer die Funktion einer Variable, Methode, Klasse… widerspiegeln. Das Lesen des Codes wird erleichtert, da man direkt erkennt, für was das jeweilige Element verwendet wird.

 

Verwirrung vermeiden

Stifte keine Verwirrung, indem du Namen verwendest, die eine gewisse Funktion, die nicht gegeben ist, suggerieren. Ein Beispiel: Die Methode „public String setName();“ suggeriert einen set-Befehl, besitzt aber einen Rückgabewert, was wiederum auf einen get-Befehl hinweist.

 

Aussprache beachten

Nutze aussprechbare Namen. Dies hilft dir einerseits über den Code zu reden und andererseits dir die Namen besser zu merken.

 

Das gleiche Wort nutzen

Du solltest immer das gleiche Wort für das gleiche Konzept verwenden. Das heißt, dass du nicht plötzlich einen zweiten Namen, der für dasselbe steht, nutzt. Ein Beispiel: „getName()“ und „grabName()“.

 

Klassen und Interface Benennung

Die Benennung von Klassen und Interfaces folgt drei einfachen Regeln:

  1. Verwende nur Nomen und Nomenphrasen (also keine Verben/Adjektive)
  2. Vermeide Worte wie: „Manager“, „Processor“, „Data“, etc.
  3. „UpperCamelCase“:
    • Der erste Buchstabe ist immer großgeschrieben
    • Jedes neue Wort beginnt mit einem neuen Großbuchstaben
    • Beispiel: „Person“, „Dog“.

 

Methoden Benennung

Für die Benennung von Methoden benötigst du zwei einfache Regeln:

  1. Beginne mit einem Verb oder einer Verb-Phrase
  2. „LowerCamelCase“
    • Erster Buchstabe immer groß
    • Jedes neue Wort beginnt mit einem neuen Großbuchstaben
    • Beispiel: „getPerson();“, “ setDog();“

 

Fazit

Diese Regeln helfen dir, sauberen Code zu schreiben. Um aber ein noch besseres Verständnis von sauberem Code zu erlangen, solltest du unbedingt das Buch „Clean Code“ von Robert Martin lesen (Die Konzepte aus diesem Artikel basieren auf diesem Buch). Robert Martin zeigt neben der Benennung eine Menge weiterer Aspekte, die Code „sauber“ machen. Daher ist dieses Buch eine klare Buchempfehlung.

 

 

 

Das könnte dich auch interessieren...