Die Java-Sprache verfügt über einen gut etablierten Satz von Namenskonventionen, die dabei helfen, die Lesbarkeit und Organisation des Codes aufrechtzuerhalten. Diese Konventionen sind ausführlich in der Java Language Specification (JLS) dokumentiert und können in typografische und grammatikalische Konventionen eingeteilt werden.
Typografische Konventionen
Typografische Namenskonventionen umfassen Pakete, Klassen, Schnittstellen, Methoden, Felder und Typvariablen. Wenn Sie sie befolgen, bleibt der Code konsistent und vermeidet Verwirrung, sodass er einfacher zu verwenden und zu warten ist. Zu den Best Practices:
Pakete und Module: Sie müssen hierarchisch, durch Punkte getrennt und aus Kleinbuchstaben bestehen. Pakete, die außerhalb der Organisation verwendet werden, müssen mit der Domäne rückwärts beginnen, z. B. com.google oder org.apache.
Klassen und Schnittstellen: Sie müssen PascalCase-Namen wie ArrayList oder FutureTask haben, wobei vollständige Namen bevorzugt und Abkürzungen vermieden werden, sofern sie nicht allgemein akzeptiert werden (HttpUrl anstelle von HTTPURL).
Methoden und Felder: Benannt in CamelCase mit dem ersten Kleinbuchstaben, wie etwa „remove“ oder „getCapacity“. Konstantenfelder (endgültige statische Felder) müssen in Großbuchstaben geschrieben werden, wobei die Wörter durch Unterstriche getrennt sind, zum Beispiel MAX_VALUE.
Lokale Variablen: Kann Abkürzungen und einzelne Zeichen wie i, Summe oder Index verwenden, insbesondere für Schleifen und temporäre Variablen.
Typparameter: Dies sind normalerweise einzelne Buchstaben, wie z. B. T für einen generischen Typ, E für den Elementtyp einer Sammlung und K und V für Schlüssel und Werte einer Karte.
Grammatikkonventionen
Grammatische Konventionen variieren je nach Art des Bezeichners, wobei der Schwerpunkt auf der Klarheit der Funktion des Elements liegt:
Klassen: Verwenden Sie Substantive oder Nominalphrasen (Thread, ArrayList), während Utility-Klassen normalerweise im Plural vorliegen (Collections, Collectors).
Schnittstellen: Schnittstellennamen können Substantive oder Adjektive verwenden, die auf „able“ oder „ible“ enden, wie z. B. Runnable oder Comparable.
Methoden: Aktionsfunktionen haben Namen in Verben (append, drawImage). Boolesche Methoden beginnen oft mit is oder has (isEnabled, hasNext).
Getter und Setter: Methoden, die Werte zurückgeben, haben einen Namen mit einem Substantiv oder beginnen mit get, während Methoden, die Werte ändern, mit set beginnen. Beispiel: getAge und setAge.
Konvertierungsmethoden: Für Typkonvertierungen werden Konventionen wie toString und asList verwendet. Statische Fabriken werden normalerweise mit from, of oder getInstance benannt.
Bedeutung von Konventionen
Die Einhaltung dieser Konventionen verbessert die Lesbarkeit und Konsistenz des Codes und erleichtert so die Teamarbeit und Wartung. Obwohl typografische Konventionen strenger sind, ermöglichen grammatikalische Konventionen eine größere Flexibilität, sodass sich der Programmierer an die Anforderungen des Kontexts und der herkömmlichen Verwendung anpassen kann.
Das obige ist der detaillierte Inhalt vonArtikel Übernehmen Sie allgemein anerkannte Namenskonventionen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!