Java代码规范
大约 1 分钟
命名方式
- 所有变量、方法、类名：要求见名知意，不应过于追求简单，而是尽可能清晰表达出作用。
- 局部变量、成员变量、方法名：使用首字母小写的驼峰命名。
- 类名：使用首字母大写的驼峰命名。
- 常量：使用全大写字母的下划线命名。
- 包名：常用倒置的公司域名。
- 方法的命名应该偏重于功能而非执行的过程。
动词选用
动词选取要精准，动词决定了函数的具体动作，而名词决定了函数具体的操作对象。
常用动词：
| 类别 | 单词 |
|---|---|
| 添加/插入/创建/初始化/加载 | add、append、insert、create、initialize、load |
| 删除/销毁 | delete、remove、destroy、drop |
| 打开/开始/启动 | open、start |
| 关闭/停止 | close、stop |
| 获取/读取/查找/查询 | get、fetch、acquire、read、search、find、query |
| 设置/重置/放入/写入/释放/刷新 | set、reset、put、write、release、refresh |
| 发送/推送 | send、push |
| 接收/拉取 | receive、pull |
| 提交/撤销/取消 | submit、cancel |
| 收集/采集/选取/选择 | collect、pick、select |
| 提取/解析 | sub、extract、parse |
| 编码/解码 | encode、decode |
| 填充/打包/压缩 | fill、pack、compress |
| 清空/拆包/解压 | flush、clear、unpack、decompress |
| 增加/减少 | increase、decrease、reduce |
| 分隔/拼接 | split、join、concat |
| 过滤/校验/检测 | filter、valid、check |
名词选用
对于名词，尽量使用领域词汇，不要使用生僻或者大家很少使用的词语。