文章 10
浏览 5554
《代码整洁之道》- 读书笔记 (1)命名的规范与意义

《代码整洁之道》- 读书笔记 (1)命名的规范与意义

doge 我们往往写代码的时候,需要对包名、对象、方法等进行命名,发现命名也是一门技术活,好的命名,会让代码可读性大大提升,正所谓顾名思义。

1、名副其实

所谓名副其实,就是命名可以很好的诠释对应的方法、或属性代表的意义,

例如一个方法里面的计数字段
	
* 错误示范 :
	
	int i = 0 int j = 0,"i"、"j" 会让读代码的的人,在代码中迷失,
	
* 正确示范:
	
	int invokeCount =0,int successCount = 0; 会让读者顾名思义,调取总数,成功总数

2、避免语义误导

命名时,正确使用语言或者其他常用的关键词,例如,hp, List, Array 等,还有让人傻傻分不清的,“1” 与 “l”, “0” 与 “O” 与 “o”,防止误导

* 错误示范: 

List userArray,Object[]  userList  误导码农对变量的类型理解

* 正确示范

List userList, List users,Object[] userArray;

3、做有意义的区分

同一作用域下,两个不同类型的东西不能同名,也尽量避免a1、a2、aN 这种命名,还有比如,getUserData 和 getUserInfo 之类的命名,同指一类东西,命名却不一样,造成意义含混,好比a、an和the一样

4、使用大家都读得懂的命名

比如"expadaga",跟人交流时,就会说“expa...”撒的变量,巴拉巴拉,增加沟通成本

5、尽量避免中英混合命名

比如 myDaDao(中英混合,我的大刀),看到这种命名,确实想抽出我的大刀摩擦

6、类名和对象名,尽量使用名词或名词短语命名

7、方法名尽量使用动词或动词短语命名

8、每个行为用固定词,比如插入-》insert,更新-》update 等

9、对名字适当添加语境,比如name,改为userName,carName

10、不要添加没用的语境,比如一个应用是GSD应用,然后在所有类名前都添加了GSD前缀,这种是没用的语境


标题:《代码整洁之道》- 读书笔记 (1)命名的规范与意义
作者:T-Aoker
地址:https://aoaos.top/articles/2020/03/31/1585627195206.html

记录精彩的程序人生