So benennen Sie Java

1. Paketnamen sollten in Kleinbuchstaben geschrieben sein und zwischen Punkttrennzeichen sollte nur ein englisches Wort mit natürlicher Semantik stehen. Paketnamen verwenden immer die Singularform, aber wenn der Klassenname eine Pluralbedeutung hat, kann der Klassenname die Pluralform verwenden.

Positives Beispiel: Der Name des Anwendungs-Tool-Pakets ist com.java.util, der Klassenname ist StringUtils

2 Der Klassenname und der Schnittstellenname verwenden den UpperCamelCase-Stil und müssen der Kamel-Schreibweise folgen die folgenden Ausnahmen:DO/BO/DTO/VO/AO/PO/UID usw.

Positivbeispiel:

UserLoginCheckService/UserDO

Gegenbeispiel:

UserLoginCheckService/UserDO

3. Methodennamen, Parameternamen, Mitgliedsvariablen und lokale Variablen verwenden alle den LowerCamelCase-Stil und müssen folgen Kamelgehäuseform.

Positivbeispiel:

userServiceImpl

Gegenbeispiel:

userServiceImpl

4. Konstantennamen werden alle großgeschrieben und Wörter werden durch Unterstriche getrennt. und seien Sie nicht mit langen Namen unzufrieden.

Positivbeispiel:

MAX_BOOK_COUNT/CACHE_EXPIRED_TIME

Gegenbeispiel:

MAX_COUNT/EXPIRED_TIME

5. Um das Ziel der Selbsterklärung des Codes zu erreichen, verwenden Sie bei der Benennung benutzerdefinierter Programmierelemente as Vervollständigen Sie eine Wortkombination so weit wie möglich, um ihre Bedeutung auszudrücken, das heißt, „den Namen zu sehen und die Bedeutung zu kennen“.

Positives Beispiel: In JDK lautet der Klassenname, der atomare Aktualisierungen ausdrückt: AtomicReferenceFieldUpdater

Gegenbeispiel:

String a = "李四"; // 天啦噜，鬼知道你这个a是啥意思啊

6. Bei der Definition eines Arrays ist der Typ eng mit verbunden die eckigen Klammern.

Positivbeispiel:

int[] array = new int[10];
int array[] = new int[10]; // 不建议这样写

7. Der Name der abstrakten Klasse beginnt mit „Abstract“ oder „Base“; der Name der Testklasse beginnt mit dem Namen der Klasse Es handelt sich um test und endet mit Test .

Beispiel:

AbstractService/CommonException/DemoTest

8. Vermeiden Sie völlig ungewöhnliche Abkürzungen, um die Bedeutung des Textes nicht zu übersehen.

Gegenbeispiel: Die „Abkürzung“ von „AbstractClass“ heißt AbsClass; die „Abkürzung“ von „condition“ heißt „condi“.

9. Wenn Module, Schnittstellen, Klassen und Methoden Entwurfsmuster verwenden, müssen sich die spezifischen Muster in der Benennung widerspiegeln.

Erläuterung: Die Widerspiegelung des Designmusters im Namen hilft den Lesern, das architektonische Designkonzept schnell zu verstehen.

Positivbeispiel:

public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;

10. Für Service- und DAO-Klassen, basierend auf dem Konzept von SOA, muss der exponierte Dienst eine Schnittstelle sein, und die interne Implementierungsklasse unterscheidet sich von der Schnittstelle durch das Suffix von Impl.

Positivbeispiel: CacheServiceImpl implementiert die CacheService-Schnittstelle

11. Wenn es sich um einen Schnittstellennamen handelt, der eine Fähigkeit beschreibt, verwenden Sie das entsprechende Adjektiv als Schnittstellennamen (normalerweise ein Adjektiv von –able).

Positivbeispiel: Vergleichbare Schnittstelle im JDK

12. Wenn Sie long oder Long einen Wert zuweisen, verwenden Sie nach dem Wert ein großes L, kein kleines l. Kleinbuchstaben können leicht mit der Zahl verwechselt werden 1, was zu Missverständnissen führt.

Erklärung: Long a = 2l; wird es als Zahl 21 oder als 2 in Long-Schrift geschrieben? ?

13. Es dürfen keine magischen Werte (also nicht vordefinierte Konstanten) direkt im Code erscheinen

Positivbeispiel:

public static final ORDER_REDIS_KEY_PREFIX = "orderId_";
String orderRedisKey = ORDER_REDIS_KEY_PREFIX + orderId;

Gegenbeispiel:

String redisKey = "orderId_" + orderId;

14. Der Name der Aufzählungsklasse sollte das Suffix Enum haben. Die Namen der Aufzählungsmitglieder müssen in Großbuchstaben geschrieben sein und die Wörter sollten durch Unterstriche getrennt sein.

Positives Beispiel: Aufzählung des Mitgliedsnamens mit dem Namen ProcessStatusEnum: SUCCESS / UNKNOWN_REASON

PHP-chinesische Website, es gibt viele kostenlose JAVA-Einführungs-Tutorials, jeder ist willkommen, es zu lernen!

Das obige ist der detaillierte Inhalt vonSo benennen Sie Java. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!