Browse Source

Updated files

master
adiao 3 years ago
parent
commit
46f318027f
  1. 34
      项目命名/项目命名格式.md

34
项目命名/项目命名格式.md

@ -33,11 +33,11 @@ team team.团队名.项目名.模块名.…… 团队项目,指由团队发起 @@ -33,11 +33,11 @@ team team.团队名.项目名.模块名.…… 团队项目,指由团队发起
对于一些特殊特有名词缩写也可以使用全大写命名,比如 XMLHttpRequest,不过笔者认为缩写三个字母以内都大写,超过三个字母则按照要给单词算。这个没有标准如阿里巴巴中 fastjson 用 JSONObject 作为类命,而 google 则使用 JsonObjectRequest 命名,对于这种特殊的缩写,原则是统一就好。
| 属性 约束 例
| 抽象类 Abstract 或者 Base 开头 BaseUserService
| 枚举类 Enum 作为后缀 GenderEnum
| 工具类 Utils 作为后缀 StringUtils
| 异常类 Exception 结尾 RuntimeException
| 属性 | 约束 | |
| 抽象类| Abstract 或者 Base 开头 BaseUserService
| 枚举类| Enum 作为后缀 GenderEnum
| 工具类| Utils 作为后缀 StringUtils
| 异常类| Exception 结尾 RuntimeException
| 接口实现类 接口名+ Impl UserServiceImpl
| 领域模型相关 /DO/DTO/VO/DAO 正例:UserDAO 反例:UserDo, UserDao
| 设计模式相关类 Builder,Factory 等 当使用到设计模式时,需要使用对应的设计模式作为后缀,如 ThreadFactory
@ -81,18 +81,18 @@ team team.团队名.项目名.模块名.…… 团队项目,指由团队发起 @@ -81,18 +81,18 @@ team team.团队名.项目名.模块名.…… 团队项目,指由团队发起
##### 4.4 异步相关方法
| 位置 | 单词 | 意义| 例 |
| :-----| :------| :-------| :------------- |
| Prefix |blocking| 线程阻塞方法| blockingGetUser
| Suffix |InBackground| 执行在后台的线程| doInBackground
| Suffix |Async| 异步方法 |sendAsync
| Suffix |Sync| 对应已有异步方法的同步方法 |sendSync
| Prefix or Alone| schedule |Job 和 Task 放入队列| schedule, scheduleJob
| Prefix or Alone| post| 同上 |postJob
| Prefix or Alone| execute| 执行异步方法(注:我一般拿这个做同步方法名)| execute, executeTask
| Prefix or Alone| start| 同上 |start, startJob
| Prefix or Alone| cancel| 停止异步方法| cancel, cancelJob
| Prefix or Alone| stop |同上 |stop, stopJob
| 位置 | 单词 | 意义| 例 |
| :-----| :------| :-------|:----------------------|
| Prefix |blocking| 线程阻塞方法| blockingGetUser |
| Suffix |InBackground| 执行在后台的线程| doInBackground |
| Suffix |Async| 异步方法 | sendAsync |
| Suffix |Sync| 对应已有异步方法的同步方法 | sendSync |
| Prefix or Alone| schedule |Job 和 Task 放入队列| schedule, scheduleJob |
| Prefix or Alone| post| 同上 | postJob |
| Prefix or Alone| execute| 执行异步方法(注:我一般拿这个做同步方法名)| execute, executeTask |
| Prefix or Alone| start| 同上 | start, startJob |
| Prefix or Alone| cancel| 停止异步方法| cancel, cancelJob |
| Prefix or Alone| stop |同上 | stop, stopJob |
##### 4.5 回调方法

Loading…
Cancel
Save