80% der Lebenszykluskosten von Software entfallen auf Wartung. Keine Software wird von nur einem Entwickler betreut. Deswegen ist es entscheidend, dass der Code in einer gut verständlichen und nachvollziehbaren Art und Weise geschrieben ist. Code Conventions helfen, dabei das zu erreichen.

Was sind Code Conventions?

Code Conventions sind Richtlinien über die strukturelle Qualität von Software. Sie umfassen allgemeine Programmierstandards sowie „Best Practices“ und programmiersprachen spezifische Aspekte. Durch das Befolgen dieser Richtlinien kann die Les- und Nachvollziehbarkeit des Source Codes verbessert werden. Dadurch wird es einfacher, die Software zu warten. Normalerweise umfassen Code Conventions folgende Bereiche: Dateiorganisation, Einrückung, Kommentierung, Deklarationen, Statements, Leerzeichen, Namenskonventionen, Programmierstandards, Programmierprinzipien und architektonische Best Practices.

Wenn du die Code Conventions einer Programmiersprache liest, fragst du dich vielleicht: „Warum schreiben die das auf? Das ist doch offensichtlich! Das weiß doch jeder!“ Wenn du aber in einem Team zusammen arbeitest, ist es unerlässlich sich an gemeinsame Regeln zu halten und kleine Unterschiede zu beseitigen.

Wie lege ich Code Conventions fest?

Ein guter Weg, um mit Code Conventions zu starten ist es bereits existierende zu nehmen und diese den eigenen Bedürfnissen anzupassen. Wenn du z.B. deine Code Conventions für Java festlegen möchtest, kannst du mit denen von Sun Microsystems oder den Google Java Styleguide beginnen. Genau das haben wir gemacht. Einige der Richtlinien haben wir 1:1 übernommen, andere haben wir unseren Bedürfnissen angepasst. Natürlich kann man die Richtlinien auch erweitern.

Dies sind einige der Richtlinien und unsere Anpassungen:

Zum Start solltest du alles aufschreiben, was die Zusammenarbeit deines Teams verbessern kann. Wenn ihr mal über etwas diskutiert und euch dann auf eine Lösung einigt, könnt ihr diese in eure Code Conventions aufnehmen um zukünftige Diskussionen zu vermeiden. Seht sie aber nicht als „in Stein gemeißelt“ an, denn vielleicht ändern sich Rahmenbedingungen oder ihr entwickelt euch einfach weiter. Natürlich solltet ihr eure Richtlinien nicht täglich ändern, da dann niemals Routine aufkommt und das zu Verwirrung führt.

Eine gute Möglichkeit um Code Conventions in den Alltag aufzunehmen ist durch Code Reviews oder durch statische Code Analysen mit Checkstyle (für Java) oder SonarQube.

Tipp: Code Conventions sollten nicht von nur einer Person verfasst werden. Um eine hohe Akzeptanz im Team zu erreichen sollten sie durch eine Gruppe diskutiert werden.

Fazit

Code Conventions helfen dabei Code zu schreiben, der einfacher von Anderen gewartet und erweitert werden kann.
Das wichtigste an Code Conventions ist, sich an sie zu halten. Durch statische Code Reviews kann die Einhaltung von Richtlinien überprüft werden. Manuelle Reviews haben den Vorteil, dass zum einen der Entwickler Feedback zu seinem Code bekommt und zum anderen der „Rewiewer“ die Richtlinien weiter verinnerlicht, da er ihre Einhaltung überprüfen muss. Natürlich dauert es einige Zeit, bis jeder die Code Conventions verinnerlicht hat, aber auf lange Sicht helfen sie dabei, besser lesbaren Code zu schreiben.

Dieser Beitrag wurde ursprünglich in unserem Partnerblog vom SCM-Manager Universe Team veröffentlicht.

Kommentare

Keine Kommentare

Ähnliche Beiträge

SLF4J und Logback in Android

Autor
  • Johannes Schnatterer
Publiziert

Wenn man als Java-Entwickler in die Android-Entwicklung einsteigt, ist zunächst vieles aus Java bekannt. Einige Aspekte sind aber auch anders gelöst. So zum Beispiel das Thema Logging. Hier bringt Android seine eigene API mit, die ohne weitere Konfiguration bequem verwendet werden kann. Bei fortgeschrittenen Herausforderungen zeigt dieser Ansatz jedoch seine Grenzen. Hier kann auf vorhandenes Wissen und Bibliotheken aus der Java-Welt zurückgegriffen werden.

Mutation Testing mit Pitest

Autor
  • Philipp Czora
Publiziert

Codequalität und -korrektheit lassen sich unter anderem mit Hilfe von Unit-Tests sicherstellen. Aber nicht jeder Unit-Test ist sinnvoll und häufig schaffen es Bugs von Unit-Tests unerkannt zu bleiben. Wie lässt sich die Testqualität erhöhen, um Programmierfehler zuverlässiger und früher zu erkennen?

Eine Groovy-DSL zum Erzeugen von Testdaten über JPA

Autor
  • Daniel Behrwind
Publiziert

Beim automatisierten, integrativen Testen von Software, die mit einem komplexen JPA-Datenmodell arbeitet, steht man unweigerlich früher oder später vor der Frage, wie sich semantisch sinnvolle Testdaten ohne großen Aufwand erzeugen lassen. Dieser Artikel zeigt, wie man mit Groovy eine Domain Specific Language (DSL) definieren kann, die es erlaubt, Testdaten leicht lesbar, modular und getrennt vom eigentlichen Test-Code zu definieren.

Jenkins Pipeline Plugin: Code-Vervollständigung in IntelliJ

Autor
  • Johannes Schnatterer
Publiziert

Das Pipeline Plugin (früher Workflow Plugin) für Jenkins revolutioniert die Arbeit mit Jenkins, indem es das Erstellen von Build Jobs als Code ermöglicht. Dadurch werden Build Pipelines unter anderem wiederverwendbar, versionierbar, testbar und einfacher lesbar als etwas “Zusammengeklicktes“.