代码是思维的产物。软件开发,命名随处可见,包括变量,函数,参数,类,包等。
好的名字,能提高代码可读性,便于软件维护,是软件重构的一项重要工作。
如何做好代码的命名呢?根据查阅资料和自己平时的经验,总结了以下规则,供大家参考:
1. 名副其实:名字含义与实际相符,为什么存在,做什么事的,不用注释补充时,也要能体现出来。
# 正例 voClassName
2.避免误用
#误用专有名词
#两个词太相似,难以区分.特别是包名或类名取名较长的时候
#别用0,o, 1,l混淆
3.做有意义的区分
#反例,a1,a2..... b1,b2....
#名称要提供正确的信息
4.使用读得出来的名称
如用几个单词的首字母拼成的,会让人很费解。
5.使用可搜索的名称
单个字母名称和数字,使用时,在代码中很难找出来,从而造成错误。
名称长短要与其作用域大小相对应。
6.类名,对象名,应该是名词或名称短语,不应是动词
7.方法名是动词或动词短语
8.要保持一致:每个概念对应一个词,一以贯之的命名,容易让人理解。
#如大家通用的包路径命名是,公司名称.开发组名称.项目名称。自己也尽量要保持一致,方便后期理解维护。
#另外注意沿用公司已定的命名规范
9.别用双关的词
#如add,可表示求和,又可表示新增的意思
总结,工作或是生活,重视细节,每天进步一点!
网友评论