java怎样定名【JAVA教程】,java,命名
1、包名一致运用小写,点分隔符之间有且唯一一个天然语义的英语单词。包名一致运用单数情势,然则类名假如有复数寄义,类名能够运用复数情势。
正例:运用工具包名为com.java.util、类名为StringUtils
2、类名、接口名运用UpperCamelCase作风,必需顺从驼峰情势,但以下情况破例:DO/BO/DTO/VO/AO/PO/UID等。
正例:
UserLoginCheckService/UserDO
反例:
userlogincheckservice/UserDo
3、要领名、参数名、成员变量、局部变量都一致运用lowerCamelCase作风,必需顺从驼峰情势。
正例:
userServiceImpl
反例:
userserviceimpl
4、常量定名悉数大写,单词间用下划线离隔,力图语义表达完全清晰,不要嫌名字长。
正例:
MAX_BOOK_COUNT/CACHE_EXPIRED_TIME
反例:
MAX_COUNT/EXPIRED_TIME
5、为了到达代码自诠释的目的,任何自定义编程元素在定名时,运用只管完全的单词组合来表达其意,即要做到“见名知意”。
正例:在 JDK 中,表达原子更新的类名为:AtomicReferenceFieldUpdater
反例:
String a = "李四"; // 天啦噜,鬼晓得你这个a是啥意思啊
6、定义数组时,范例与中括号紧挨相连。
正例:
int[] array = new int[10]; int array[] = new int[10]; // 不发起如许写
7、抽象类定名运用 Abstract 或 Base 开头;非常类定名运用 Exception 末端;测试类定名以它要测试的类的称号入手下手,以 Test 末端。
正例:
AbstractService/CommonException/DemoTest
8、根绝完全不范例的缩写,防止望文不知义。
反例:AbstractClass“缩写”定名成 AbsClass;condition“缩写” 定名成 condi,此类随便缩写严峻降低了代码的可浏览性。
9、假如模块、 接口、类、要领运用了设想形式,在定名时需体现出细致形式。
申明:将设想形式体现在名字中,有利于浏览者疾速明白架构设想理念。
正例:
public class OrderFactory; public class LoginProxy; public class ResourceObserver;
10、关于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的效劳一定是接口,内部的完成类用Impl 的后缀与接口区分。
正例:CacheServiceImpl完成CacheService接口
11、假如是描述才能的接口称号,取对应的描述词为接口名(通常是–able 的描述词)。
正例:JDK中的Comparable接口
12、在long或许Long赋值时,数值后运用大写的 L,不能是小写的 l,小写轻易跟数字 1 殽杂,形成误会。
申明:Long a = 2l;写的是数字的 21,照样 Long 型的 2 ??
13、不允许任何魔法值(即未经预先定义的常量)直接出现在代码中
正例:
public static final ORDER_REDIS_KEY_PREFIX = "orderId_"; String orderRedisKey = ORDER_REDIS_KEY_PREFIX + orderId;
反例:
String redisKey = "orderId_" + orderId;
14、罗列类名带上Enum后缀,罗列成员称号须要全大写,单词间用下划线离隔。
正例:罗列名字为ProcessStatusEnum的成员称号:SUCCESS / UNKNOWN_REASON
ki4网,有大批免费的JAVA入门教程,迎接人人进修!
以上就是java怎样定名的细致内容,更多请关注ki4网别的相干文章!