Entwicklung eines IDE-Plugins zur Prüfung von Clean Code-Regeln

Clean Code, also sauber geschriebener Quelltext, ist ein elementarer Bestandteil für die Softwarequalität. Unter Clean Code versteht man saubere Struktur, Lesbarkeit und einfach verständlichen Quelltext. Clean Code begünstigt vor allem die Wartbarkeit und Erweiterbarkeit und sollte bei jedem Software Projekt hohe Priorität geniessen.

Regeln für das Schreiben von gutem Quelltext sind viele bekannt und wurden auch schon in vielen Büchern niedergeschrieben. Diese Regeln gehen allerdings auch erfahrenen ProgrammiererInnen, beim entwickeln von Software, immer mal wieder vergessen. Für gewisse dieser Regeln gibt es verschiedene Werkzeuge die sicherstellen, dass sie eingehalten werden oder bei Verstössen die EntwicklerIn darauf aufmerksam machen. Für andere fehlt ein solches Werkzeug, insbesondere für die Benennung von Bezeichnern gibt es einige Lücken. Für angehende EntwicklerInnen wäre aber ein solches Werkzeug hilfreich, da sie sich bereits in der Phase des Erlernens der Sprachkonzepte durch sofortige Rückmeldungen an gute Namensgebung gewöhnen würden. Dieses Problem wollten wir im Rahmen dieser Arbeit mit der Entwicklung einer Erweiterung für die Entwicklungsumgebung Visual Studio Code adressieren.

Das erstellte Plugin prüft den geschriebenen Quelltext gegen von uns gesammelt und implementierte Regeln. Gefundene Verstösse werden in der Entwicklungsumgebung farbig markiert und die EntwicklerIn erhält Problembeschreibungen welche sie darin unterstützen sollen das Problem zu lösen.

Initial haben wir Fachliteratur zum Thema Clean Code konsultiert und systematisch Regeln daraus gesammelt. Diese Regeln haben wir dann genauer analysiert, kategorisiert und auf ihre Umsetzbarkeit geprüft. Danach haben wir einen Prototyp der Erweiterung gebaut, welcher die technologische Umsetzbarkeit unserer angedachten Regelprüfung bestätigte. Basierend auf den daraus gewonnenen Erkenntnissen haben wir eine Architektur abgeleitet und darauf aufbauend die tatsächliche Erweiterung entwickelt.

Mit unserer Arbeit konnten wir aufzeigen, wie eine Erweiterung zur Prüfung von Clean Code Regeln in Visual Studio Code umgesetzt werden kann. Diese haben wir mit einigen Regeln zur Benennung von Bezeichnern und Benachrichtigung der ProgrammiererIn bei Regelverstössen umgesetzt. Dies legt die Grundlage, welche in eine umfänglichere Erweiterung mit mehr Regelprüfungen und Unterstützung für mehr Programmiersprachen ausgebaut werden kann.