Clean Code Notation
Der Begriff "Clean Code" bezieht sich auf die Anwendungsentwicklung und wurde von Robert C. Martin in seinem gleichnamigen Buch geschaffen. Als sauberen Code (oder Clean Code) bezeichnen Entwickler üblicherweise einen Quellcode, der intuitiv verständlich ist.Der Begriff "Clean Code" wird ebenso auf Konzepte, Regeln, Verfahren und Dokumente angewandt. Intuitiv verständlich ist alles, was in kürzester Zeit und mit wenig Aufwand nachvollzogen werden kann.
Die Clean Code Notation vermeidet Abkürzungen für Variablen und Datentypen zu verwenden.
Clean Code-Notation - Aufbau und Struktur
Letztlich wird "Clean Code" von den Programmierern in unterschiedlicher Weise gedeutet. Einigkeit besteht allerdings darüber, dass ein guter und sauberer Code elegant und effizient sein muss. Er sollte einfach, geradeheraus, jederzeit leicht erweiterbar und leicht wartbar sein. "Clean Code" macht exakt das, was erwartet wird und sieht "gepflegt" aus, ganz so als liege er dem Programmierer am Herzen.
Dazu gehören aussagekräftige Bezeichner, effiziente Funktionen und hinweisführende Kommentare.
Aussagekräftige Bezeichner
Der Name eines Bezeichners sollte den Nutzen und Sinn direkt enthalten. Ziffern sollten an dieser Stelle vermieden werden. Um eine gute Zusammenarbeit in einem Team zu realisieren, ist es hilfreich, wenn alle Bezeichner für alle Beteiligten gut auszusprechen sind. Ebenfalls sollten die Begriffe "suchbar" gestaltet werden. Dazu ist es notwendig mehr als drei Zeichen für einen Bezeichner zu verwenden. Zu lang sollte ein Bezeichner allerdings auch nicht sein. Der gewählte Name sollte so sprechend und kurz wie möglich sein.
Typinformationen werden im Clean Code Bezeichner nicht verwendet. Sollte sich der Typ einmal ändern, würde dies eine komplette Überarbeitung des Bezeichnernamens in allen Codeteilen erfordern.
Klassen und Objekte erhalten bei der Clean Code Notation ein Subjekt als Bezeichner, Methoden ein Verb und Funktionen ein Verb und ein Subjekt.
Effiziente Funktionen
Eine effiziente Funktion ist so kurz wie möglich. Übermäßige Verschachtelungen sollten vermieden werden, da dies zur Unübersichtlichkeit führt. Die Bezeichnung der Funktion sollte das wiedergeben, was die Funktion tut.
Beinhaltet eine Funktion drei oder mehr Parameter, sollten diese in einer eigenen Klasse zusammengefasst werden.
Hinweisführende Kommentare
Als Faustregel gilt: Möglichst wenig Kommentare verwenden, jedoch so viele wie nötig. Der Code sollte so sauber geschrieben sein, dass Kommentare nicht nötig sind.
Vorteile der Clean Code-Notation
Programme mit "Clean Code" sind stabiler und einfacher zu warten. Daraus ergeben sich kürzere Entwicklungszeiten bei möglichen Funktionserweiterungen, sowie bei Fehlerbehebungen.
Vorteile gegenüber der ungarischen Notation und der CamelCase-Notation
Ein sauberer Code beinhaltet eine saubere und einfach verständliche Konvention der Bezeichnungen. Die ungarische Notation behandelt lediglich die Namenskonvention, nicht aber den sauberen Code an sich. Das Selbe gilt für die CamelCase-Notation. Die Clean Code Notation geht wesentlich weiter und befasst sich mit einem insgesamt sauberen, aufgeräumten und leicht verständlichem Code.