Comment nommer Java

1. Les noms de packages doivent toujours être en minuscules, avec un et un seul mot anglais avec une sémantique naturelle entre les séparateurs de points. Les noms de packages utilisent toujours la forme singulière, mais si le nom de classe a une signification plurielle, le nom de classe peut utiliser la forme plurielle.

Exemple positif : le package de l'outil d'application s'appelle com.java.util et le nom de la classe est StringUtils

2 Le nom de la classe et le nom de l'interface utilisent le style UpperCamelCase et doivent suivre la casse camel, Avec les exceptions suivantes ：DO/BO/DTO/VO/AO/PO/UID, etc.

Exemple positif :

UserLoginCheckService/UserDO

Contre-exemple :

userlogincheckservice/UserDo

3 Les noms de méthodes, les noms de paramètres, les variables membres et les variables locales utilisent tous le style lowerCamelCase et doivent suivre. forme de caisse de chameau.

Exemple positif :

userServiceImpl

Contre-exemple :

userserviceimpl

4. Les noms de constantes sont tous en majuscules et les mots sont séparés par des traits de soulignement. et ne soyez pas mécontent des noms longs.

Exemple positif :

MAX_BOOK_COUNT/CACHE_EXPIRED_TIME

Contre-exemple :

MAX_COUNT/EXPIRED_TIME

5 Afin d'atteindre l'objectif d'auto-explication du code, lorsque vous nommez des éléments de programmation personnalisés, utilisez comme. compléter une combinaison de mots autant que possible Pour exprimer le sens, c'est-à-dire « connaître le sens après avoir vu le nom ».

Exemple positif : dans JDK, le nom de classe qui exprime les mises à jour atomiques est : AtomicReferenceFieldUpdater

Contre-exemple :

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

6. Lors de la définition d'un tableau, le type est étroitement lié à. les crochets.

Exemple positif :

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

7. Le nom de la classe abstraite commence par Abstract ou Base ; le nom de la classe d'exception se termine par Exception ; c'est tester et se termine par Test .

Exemple correct :

AbstractService/CommonException/DemoTest

8. Évitez les abréviations complètement non standards pour ne pas manquer le sens du texte.

Contre-exemple : L'"abréviation" de AbstractClass est nommée AbsClass ; l'"abréviation" de condition est nommée condi. Une telle abréviation arbitraire réduit sérieusement la lisibilité du code.

9. Si les modules, interfaces, classes et méthodes utilisent des modèles de conception, les modèles spécifiques doivent être reflétés dans le nom.

Remarque : refléter le modèle de conception dans le nom aidera les lecteurs à comprendre rapidement le concept de conception architecturale.

Exemple positif :

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

10. Pour les classes Service et DAO, basées sur le concept SOA, le service exposé doit être une interface, et la classe d'implémentation interne se distingue de l'interface par le suffixe d'Impl.

Exemple positif : CacheServiceImpl implémente l'interface CacheService

11. S'il s'agit d'un nom d'interface qui décrit une capacité, prenez l'adjectif correspondant comme nom d'interface (généralement un adjectif de –able).

Exemple positif : interface comparable dans JDK

12. Lorsque vous attribuez une valeur à long ou Long, utilisez un L majuscule après la valeur, et non un l minuscule qui se confond facilement avec le nombre. 1, provoquant un malentendu.

Explication : Long a = 2l ; s'écrit-il sous la forme 21 en tant que nombre, ou sous la forme 2 en caractères longs ? ?

13. Aucune valeur magique (c'est-à-dire des constantes non prédéfinies) n'est autorisée à apparaître directement dans le code

Exemple positif :

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

Contre-exemple :

String redisKey = "orderId_" + orderId;

14. Le nom de la classe d'énumération doit avoir le suffixe Enum. Les noms des membres de l'énumération doivent être en majuscules et les mots doivent être séparés par des traits de soulignement.

Exemple positif : énumérez le nom du membre nommé ProcessStatusEnum : SUCCESS / UNKNOWN_REASON

Site Web PHP chinois, il existe de nombreux tutoriels d'introduction JAVA gratuits, tout le monde est invité à apprendre !

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!