Googles Java-Codierungsstandards

Google hat kürzlich eine vollständige Java-Codierungsspezifikation veröffentlicht. Der Inhalt der Spezifikation umfasst einige praktische und strenge Bestimmungen. Google hält sich intern an diese Vorgabe. Die Spezifikation umfasst nicht nur Codeformate, sondern auch andere Arten von Konventionen und Codierungsstandards.

Die Spezifikation ist hauptsächlich in 6 Teile unterteilt: grundlegende Spezifikation der Quelldateien, Quelldateistruktur, Codeformat, Benennung, Programmierpraktiken und Javadoc. Die Grundspezifikation der Quelldatei beschreibt die Spezifikationsanforderungen wie Dateiname, Dateikodierung, Leerzeichen und Sonderzeichen. Die Quelldateistruktur beschreibt Lizenzinformationen, Paket- und Importdeklarationen, die Reihenfolge der Klassenmitglieder und andere normative Anforderungen. Das Codeformat wird verwendet, um Formatierungsanforderungen wie geschweifte Klammern, Einrückungen, Zeilenumbrüche, Leerzeichen, Klammern, Aufzählungen, Arrays, Switch-Anweisungen, Anmerkungen, Anmerkungen und Modifikatoren im Quellcode zu beschreiben. Die Benennung gibt Namenskonventionen und Groß-/Kleinschreibungsdefinitionen für Bezeichner (Pakete, Klassen, Methoden, Konstanten, Eigenschaften, lokale Variablen und Klassenvariablen) an. Programmierpraktiken veranschaulichen die Verwendung von @Override, Ausnahmen, statischen Membern und Finalizern. Javadoc beschreibt, wo Javadoc erforderlich ist und welche Formatanforderungen es hat.

Hier einige Auszüge aus der Spezifikation:

Im Import dürfen keine Platzhalter verwendet werden.

Überladene Methoden sollten zusammen platziert werden und nacheinander erscheinen.

Auch wenn der Codeblock keinen Inhalt enthält oder nur eine Codezeile vorhanden ist, müssen geschweifte Klammern verwendet werden.

2 Leerzeichen einrücken.

Spaltenbreite beträgt 80 oder 100 Zeichen.

Array-Variablendeklarationen ähnlich der C-Sprache können nicht verwendet werden.

Die Switch-Anweisung muss die Standardanweisung enthalten.

Die Reihenfolge der Modifikatoren sollte der von der Java-Sprachspezifikation empfohlenen Reihenfolge entsprechen.

Konstante Benennungen sollten das Format CONSTANT_CASE verwenden (Anmerkung: Alle Buchstaben werden großgeschrieben und Wörter werden durch Unterstriche getrennt). Beachten Sie, dass alle Konstanten statische Endelemente sein müssen, aber nicht alle statischen Endelemente Konstanten sind.

Weitere Informationen finden Sie im Google Java Style. Oracle stellt außerdem offizielle Java-Sprachcodierungsspezifikationen bereit. Google stellt auch Code-Styleguides für andere Sprachen bereit, darunter C++, Objective-C, Python, Shell, HTML/CSS, JavaScript, Lisp usw.

Original englischer Link: Googles Java Coding Standards