diff --git a/项目命名/项目命名格式.md b/项目命名/项目命名格式.md index 6c55a1d..efa7154 100644 --- a/项目命名/项目命名格式.md +++ b/项目命名/项目命名格式.md @@ -34,16 +34,17 @@ team team.团队名.项目名.模块名.…… 团队项目,指由团队发起 对于一些特殊特有名词缩写也可以使用全大写命名,比如 XMLHttpRequest,不过笔者认为缩写三个字母以内都大写,超过三个字母则按照要给单词算。这个没有标准如阿里巴巴中 fastjson 用 JSONObject 作为类命,而 google 则使用 JsonObjectRequest 命名,对于这种特殊的缩写,原则是统一就好。 | 属性 | 约束 | 例 | -| 抽象类| Abstract 或者 Base 开头| BaseUserService -| 枚举类| Enum 作为后缀| GenderEnum -| 工具类| Utils 作为后缀| StringUtils -| 异常类| Exception 结尾| RuntimeException -| 接口实现类| 接口名+ Impl| UserServiceImpl -| 领域模型相关| /DO/DTO/VO/DAO| 正例:UserDAO 反例:UserDo, UserDao -| 设计模式相关类| Builder,Factory 等| 当使用到设计模式时,需要使用对应的设计模式作为后缀,如 ThreadFactory -| 处理特定功能的| Handler,Predicate, Validator| 表示处理器,校验器,断言,这些类工厂还有配套的方法名如 handle,predicate,validate -| 测试类| Test 结尾| UserServiceTest, 表示用来测试 UserService 类的 -| MVC 分层| Controller,Service,ServiceImpl,DAO| 后缀 UserManageController,UserManageDAO +|:-----|:---------------------|:---------------| +| 抽象类| Abstract 或者 Base 开头| BaseUserService| +| 枚举类| Enum 作为后缀| GenderEnum| +| 工具类| Utils 作为后缀| StringUtils| +| 异常类| Exception 结尾| RuntimeException| +| 接口实现类| 接口名+ Impl| UserServiceImpl| +| 领域模型相关| /DO/DTO/VO/DAO| 正例:UserDAO 反例:UserDo, UserDao| +| 设计模式相关类| Builder,Factory 等| 当使用到设计模式时,需要使用对应的设计模式作为后缀,如 ThreadFactory| +| 处理特定功能的| Handler,Predicate, Validator| 表示处理器,校验器,断言,这些类工厂还有配套的方法名如 handle,predicate,validate| +| 测试类| Test 结尾| UserServiceTest, 表示用来测试 UserService 类的| +| MVC 分层| Controller,Service,ServiceImpl,DAO 后缀| UserManageController,UserManageDAO| ### 四,方法