© saicle/Shutterstock.com
PHP Magazin
Richtiges Java dank Code Conventions

Richtiges Java dank Code Conventions

Herzlich willkommen zum dritten und finalen Teil unserer Reihe „Elefanten auf Java“. Falls Sie die ersten beiden Teile aus unerfindlichen Gründen nicht gelesen haben sollten, vielleicht weil Sie auf einer einsamen Insel ohne Postzustellung gestrandet waren oder gerade erst aus einem 100-jährigen Büroschlaf wachgeküsst wurden: Lesen Sie bitte dennoch diesen Teil. Wenigstens den Anfang. Wenigstens den Teil über die Code Conventions. Und vielleicht dann noch den Rest.

Stephan Elter


Wir wollen wieder direkt einsteigen: Erst einmal mit leichter Kost, denn Elefanten leben nicht nur von Liebe allein.

Im gemeinsamen Kampf für guten Code

Wer mit den Programmcode anderer Entwickler arbeiten will, hat oft das Problem sich zuerst in den Stil des anderen Entwicklers einlesen zu müssen. Noch mehr Spaß hat man, wenn es sich um Programmcode handelt, der unkoordiniert von mehreren Entwicklern geschrieben und vielleicht sogar im Laufe von Jahren „gewachsen“ ist. Immerhin sind die wichtigsten Schlüsselwörter festgelegt und man erkennt Variablen eindeutig wegen des einleitenden $.

Java hat zwar kein einleitendes $, dafür aber die „Code Conventions“. Ein 24-seitiges, englisches Dokument aus dem Jahre 1997, in dem tatsächlich solche Fragen wie die richtige Benennung von Dateinamen, Klassen und Variablen, empfohlene Ordnerstrukturen, die Art der Einzüge, richtige Kommentierung und sogar der Aufbau des Programmcodes beschrieben werden. Ähnlich dem JDK findet man dieses Dokument auf den Webseiten von Oracle. Aber auch hier ist eine Suche über Google nach „code conventions java“ wieder schneller als ein Navigieren durch die Seiten von Oracle selbst. Auch wenn die Code Conventions sprichwörtlich aus dem letzten Jahrhundert stammen, sind sie nicht nur aktuell, sondern zumindest in Teilen auch für PHP-Entwickler ein durchaus interessanter Leitfaden. Wer vielleicht tatsächlich vor der Frage steht, sich in einem größer werdenden Team oder mit immer größer werdenden Bergen von Programmcode Regeln für das Schreiben von Programmcode zu geben, der sollte sich die Java Code Conventions einmal etwas genauer ansehen.

Alleine die Frage ob oder wie der eigene Programmcode kommentiert werden sollte, sorgt mit steter Regelmäßigkeit und immer gleichbleibender Begeisterung für die schönsten und lesenswertesten Kommentare und Auseinandersetzungen in den entsprechenden Entwicklerforen. Laut der Code Conventions soll jede Datei am Anfang einen Kommentar haben, der die Entwickler, das Datum, einen Copyright-Hinweis und eine kurze Beschreibung des Zwecks des Programms beinhaltet (oder des Programmteils, der in dieser Datei seine Arbeit verrichtet). Da es verständlicherweise wenig Sinn macht, so etwas fest als verbindliche Regeln in die Syntax einer Sprache zu meißeln, wurden bei Java eben die Code Conventions geschrieben, um einen einheitlichen Leitfaden zu haben.

Bei einigen Punkten handelt es sich eher um Ratschläge, die eigentlich sowieso dem gesunden Menschenverstand entsprech...

PHP Magazin
Richtiges Java dank Code Conventions

Richtiges Java dank Code Conventions

Herzlich willkommen zum dritten und finalen Teil unserer Reihe „Elefanten auf Java“. Falls Sie die ersten beiden Teile aus unerfindlichen Gründen nicht gelesen haben sollten, vielleicht weil Sie auf einer einsamen Insel ohne Postzustellung gestrandet waren oder gerade erst aus einem 100-jährigen Büroschlaf wachgeküsst wurden: Lesen Sie bitte dennoch diesen Teil. Wenigstens den Anfang. Wenigstens den Teil über die Code Conventions. Und vielleicht dann noch den Rest.

Stephan Elter


Wir wollen wieder direkt einsteigen: Erst einmal mit leichter Kost, denn Elefanten leben nicht nur von Liebe allein.

Im gemeinsamen Kampf für guten Code

Wer mit den Programmcode anderer Entwickler arbeiten will, hat oft das Problem sich zuerst in den Stil des anderen Entwicklers einlesen zu müssen. Noch mehr Spaß hat man, wenn es sich um Programmcode handelt, der unkoordiniert von mehreren Entwicklern geschrieben und vielleicht sogar im Laufe von Jahren „gewachsen“ ist. Immerhin sind die wichtigsten Schlüsselwörter festgelegt und man erkennt Variablen eindeutig wegen des einleitenden $.

Java hat zwar kein einleitendes $, dafür aber die „Code Conventions“. Ein 24-seitiges, englisches Dokument aus dem Jahre 1997, in dem tatsächlich solche Fragen wie die richtige Benennung von Dateinamen, Klassen und Variablen, empfohlene Ordnerstrukturen, die Art der Einzüge, richtige Kommentierung und sogar der Aufbau des Programmcodes beschrieben werden. Ähnlich dem JDK findet man dieses Dokument auf den Webseiten von Oracle. Aber auch hier ist eine Suche über Google nach „code conventions java“ wieder schneller als ein Navigieren durch die Seiten von Oracle selbst. Auch wenn die Code Conventions sprichwörtlich aus dem letzten Jahrhundert stammen, sind sie nicht nur aktuell, sondern zumindest in Teilen auch für PHP-Entwickler ein durchaus interessanter Leitfaden. Wer vielleicht tatsächlich vor der Frage steht, sich in einem größer werdenden Team oder mit immer größer werdenden Bergen von Programmcode Regeln für das Schreiben von Programmcode zu geben, der sollte sich die Java Code Conventions einmal etwas genauer ansehen.

Alleine die Frage ob oder wie der eigene Programmcode kommentiert werden sollte, sorgt mit steter Regelmäßigkeit und immer gleichbleibender Begeisterung für die schönsten und lesenswertesten Kommentare und Auseinandersetzungen in den entsprechenden Entwicklerforen. Laut der Code Conventions soll jede Datei am Anfang einen Kommentar haben, der die Entwickler, das Datum, einen Copyright-Hinweis und eine kurze Beschreibung des Zwecks des Programms beinhaltet (oder des Programmteils, der in dieser Datei seine Arbeit verrichtet). Da es verständlicherweise wenig Sinn macht, so etwas fest als verbindliche Regeln in die Syntax einer Sprache zu meißeln, wurden bei Java eben die Code Conventions geschrieben, um einen einheitlichen Leitfaden zu haben.

Bei einigen Punkten handelt es sich eher um Ratschläge, die eigentlich sowieso dem gesunden Menschenverstand entsprech...

Neugierig geworden?


    
Loading...

Angebote für Teams

Für Firmen haben wir individuelle Teamlizenzen. Wir erstellen Ihnen gerne ein passendes Angebot.

Das Library-Modell:
IP-Zugang

Das Company-Modell:
Domain-Zugang