编程随想之命名规范

2022-04-21 14:34:06 浏览数 (1)

文 | 编程随想曲

首发 | 编程随想曲

变量名(Variable)

变量名应该是名称,能够正确地描述业务,有表达力。

代码语言:javascript复制
// 表示过去的天数
int d; // NO 
int elapsedTimeInDays; // YES

函数名(Function)

函数命名要具体,空泛的命名没有意义。函数命名要体现做什么,而不是怎么做。

代码语言:javascript复制
// 获取最近存储的雇员信息
popRecord(); // NO  
getLatestEmployee; // YES

类名(Class)

类名是一组数据和操作的封装。分为实体类和辅助类。

实体类承载类核心业务数据和核心业务逻辑。

代码语言:javascript复制
Customer Bank

辅助类是辅助实体类完成业务逻辑的。

代码语言:javascript复制
CustomerController CustomerService CustomerRepository

包名(Package)

包代表了一组有关系的类的集合,起到分类组合和命名空间的作用。能反映一组类再更高抽象层次的联系。

代码语言:javascript复制
package.fruit 
class.apple 
class.pear 
class.orange

模块名(Module)

主要指Maven中的Module,一方面保证模块在Maven仓库中的唯一性,另一方面反映模块在系统中的职责。

代码语言:javascript复制
xxx-controller 
xxx-app 
xxx-domain

Reference

《代码精进之路 从码农到工匠》

0 人点赞