Benennungsregeln für die Java-Entwicklung

1. Dateien

1. Das Suffix der Eigenschaftsdatei lautet Properties und entspricht der i18n-Spezifikation in Java.
2. Die Konfigurationsdatei jedes Produktmoduls muss im Verzeichnis conf abgelegt werden eines eigenen Moduls ;
3. Der Name der Datei muss eine bestimmte Bedeutung haben und so kurz wie möglich sein. Der Name muss den Anforderungen des Betriebssystems entsprechen und aus Englisch oder Chinesisch bestehen Verwenden Sie für normale Dateien keine Leerzeichen.

2. Namenskonvention

2.1 Grundregeln

1. Der Zeichensatz besteht aus 26 englischen Buchstaben, arabischen Ziffern von 0 bis 9 und Unterstrichen. In Java sollten Klassen, Felder, Methoden, Variablen und Konstanten so weit wie möglich in Buchstaben ausgedrückt werden. Alle anderen Zeichen können nicht ohne besondere Gründe verwendet werden. 2. Die Verwendung von Namen muss eine bestimmte Bedeutung haben Terminologie in der Problemdomäne, um die Benennung präziser zu gestalten
3. Halten Sie den Namen so kurz wie möglich, können Sie Aliase oder Abkürzungen verwenden, um ihn zu vereinfachen Benennung. Abkürzungen müssen eine Bedeutung haben und die Bedeutung dieser Abkürzungen muss während des gesamten Projekts beibehalten werden
4. Regeln für Namensabkürzungen (gilt für Klassennamen, Feldnamen, Variablennamen, Modulnamen usw.)
1) Löschen Sie alle ursprünglichen Buchstaben und komprimieren Sie die wiederholten Buchstaben. Button wird beispielsweise als btn abgekürzt,
2) Bei einem Namenskonflikt bleibt der Originalton in einer bestimmten Abkürzung erhalten. Beispielsweise wird batton, um keinen Konflikt mit button zu verursachen, als batn abgekürzt
5. Verwenden Sie keine führenden Unterstriche und keine Unterstriche am Ende des Namens

2.2 Konstantennamensregeln

1. Alle Zeichen müssen in Großbuchstaben geschrieben sein. Verwenden Sie zum Ausdrücken sinnvolle Wortkombinationen, und Wörter werden durch „_“-Unterstriche getrennt.

2. Halten Sie den Namen so kurz wie möglich, nicht mehr als 16 Zeichen

Es ist am besten, während der Programmentwicklung nicht direkt an Literalen zu arbeiten. Es ist am besten, eine ständige Anwendung einzuführen unter besonderen Umständen, wie zum Beispiel beim Initialisieren von Variablen in einer for-Schleife, können Sie die Konstanten -1, 0, 1 direkt verwenden

Beispiel

publicfinalintMAX_SIZE =120;
publicfinalintMAX_WIDTH =100;
publicfinalString PROPERTY_NAME="menu";

2.3 Variablenbenennungsregeln

1. Vermeiden Sie die Verwendung der folgenden Zahlen bei der Benennung, es sei denn, die Bedeutung der Benennung ist klar und das Programm klarer. Bei der Benennung von Instanzvariablen sollten keine Zahlen enthalten sein

2. Der Variablenname ist ein Substantiv mit der Bedeutung
3. Verwenden Sie Wörter oder Wortkombinationen, die die Bedeutung des Problembereichs haben. Das erste Wort besteht ausschließlich aus Kleinbuchstaben, jedes nachfolgende Wort wird groß geschrieben und der Rest ist kleingeschrieben (außer Sonderwörtern wie URL)
4. Halten Sie den Namen so kurz wie möglich, nicht mehr als 16 Zeichen
5. Neben dem sehr kurzen Lebenszyklus vermeiden Sie mit Ausnahme kurzer temporärer Variablen die Verwendung einzelner Zeichen als Variablennamen und verwenden bei der Benennung von Instanzvariablen keine einzelnen Zeichen. Häufig verwendete Einzelzeichenvariablen wie Ganzzahltypen verwenden i, j, k, m, n. Zeichentypen verwenden c, d, e und Koordinaten verwenden x, y, z.
6. In einigen Fällen müssen Variablen möglicherweise mit einem Typpräfix hinzugefügt werden. Zwischen ihnen und dem Entitätsteil des Variablennamens darf keine Lücke bestehen Der erste Buchstabe wird groß geschrieben (mit Ausnahme spezieller Wörter wie URL). Das allgemeine Typpräfix lautet wie folgt:

publicintwidth;
publicString fileName;
publicstaticApplicationContext context;

2.4 Methodenbenennungsregeln

1. Verwenden Sie Wörter oder Wortkombinationen, die zur Bedeutung der Problemdomäne passen. Das erste Wort ist kleingeschrieben, jedes nachfolgende Wort ist großgeschrieben und der Rest ist kleingeschrieben (mit Ausnahme spezieller Wörter wie URL). Es gibt keinen besonderen Grund, Unterstriche nicht als Trennzeichen zu verwenden

2. Die Benennung von Attributmethoden in Java folgt den JavaBean-Regeln Standard:
1) Getter-Methode: get+attribute name, verwenden Sie is+attribute name für den booleschen Typ, einige spezifische Attributnamen könnten besser sein zu verwenden has, can statt is
2) Setter-Methode: set+attribute Name
3. Die Benennung der Konstruktormethode stimmt mit dem Klassennamen überein

2.5 Benennungsregeln für Klassen und Schnittstellen

1. Verwenden Sie Wörter oder Wortkombinationen, die der Bedeutung des Problems entsprechen Domäne, wobei der erste Buchstabe jedes Wortes großgeschrieben wird (außer Sonderwörtern wie URL)

2. Das erste Zeichen der Schnittstelle ist Ｉ

Beispiel

publicclassFiugre
publicinterfaceFiugreContainer
publicclassStdFigure//std为Standard的缩写

2.6 Paketbenennungsregeln

1. Alle Zeichen im Paketnamen sind Kleinbuchstaben;

2. Es sollte keine wechselseitige Abhängigkeit zwischen zwei Paketen mit unterschiedlichen Geschäften bestehen, sondern eine einseitige Abhängigkeit;
3. Nehmen Sie eine logische hierarchische Struktur an, um Abhängigkeiten zu reduzieren