Sourcecode wird öfter gelesen als geschrieben. Dies ist eine Tatsache, die man nur schwer verneinen kann. Oft müssen neue Features implementiert werden, wobei erst die richtige Stelle gefunden werden muss, um diese umzusetzen. Auch wenn im Programm Fehler zu suchen sind muss man den Sourcecode lesen. Der Sourcecode sollte deshalb so geschrieben werden, dass er schnell verstanden werden kann. Zur Lesbarkeit trägt dabei die Verwendung von klaren Klassen-, Methoden- und Variablen-Bezeichnungen wesentlich bei. Des Weiteren sollte der Sourcecode klar strukturiert sein.

Ein Team sollte sich deshalb auf einen Coding Standard einigen, an den sich jeder zu halten hat. Das Einhalten der Regeln zu überprüfen ist eine aufwendige Arbeit, bei der man sich durch den Einsatz entsprechender Tools helfen lassen kann. In der Java-Welt findet sich hier einiges.

Eine Möglichkeit wäre, die Formatierung der Sourcecodes während des Buildprozesses zu erledigen. Hier kann das Maven-Plugin formatter-maven-plugin eingesetzt werden. Das Resultat des Buildprozesses ist dabei nicht das fertige Programm, sondern ein entsprechend formatierter Sourcecode. Setzt man auf diese Möglichkeit ist es aber weiterhin die Aufgabe der Entwickler, den Buildprozess anzustoßen, bevor der Sourcecode am Ende an ein zentrales Continuous Integration (CI) Tools übergeben und im Kontext Continuous Delivery weitergeführt wird.

Durch den Einsatz des Maven-Plugins maven-checkstyle-plugin kann dieser Prozess verbessert werden. Dieses Plugin übernimmt die Aufgabe, das Einhalten des Coding Standards zu gewährleisten. Verletzungen führen zu einem Fehler während des Buildprozesses. Checkstyle lässt sich auch in die Entwicklungsumgebung (z.B. Eclipse) integrieren. So können die Entwickler gleich Verletzungen des gewählten Coding Standards vermeiden.

Die vorgestellten Tools haben jedoch den Nachteil, dass sie meist nur einen Teil des Sourcecodes beachten. In Projekten gibt es aber meist unterschiedliche Dateien wie z.B. XML-, HTML-Dateien. Auch diese Dateien sollten eine einheitliche Struktur aufweisen und deshalb durch den Coding Standard abgedeckt sein. Die Entwicklungsumgebung Eclipse bietet hier umfangreiche Einstellungsmöglichkeiten, um zu definieren, wie die Struktur solcher Dateien sein sollte.

Tools erleichtern es bei der Softwareentwicklung bzw. den Entwicklern den gewählten Coding Standard einzuhalten. Die wichtigste Aufgabe, um den Sourcecode gut lesbar zu machen, ist jedoch weiterhin in der Hand der Entwickler. Gut lesbarer Software Code bedeutet daher auch gut lesbare Klassen-, Methoden- und Variablen-Bezeichnungen.

‍

‍

Qualitätscheckliste für Ihre Codebase!

Hier finden Sie die konkrete Objectbay Code Review Checkliste, mit der Sie eine hohe Codequalität gewährleisten können.