命名
几个命名的简单规则
1.命名能够让人更容易理解名称意思和修改代码
2.避免误导,比如数字01和字母ol,避免使用区别不大的名称
3.当两个参数需要做有区分的命名时,注意避免无意义的区分,比如ProductInfo和ProductData。要做有意义的区分,比如加前缀a,the。不写废话,比如variable不能出现在变量名中,table不能出现在表中等。
4.使用读的出来的名称,当讨论代码时,不方便读的命名会使代码讨论交流效率降低
5.使用可搜索(查找)的名称。名称长短应与其作用域大小相对应,比如单字母仅用于短方法。
6.避免使用编码,使用编码命名增加了修改变量,函数或类的名称或类型的难度,增加了阅读代码的难度,制造了让编码系统误导读者的可能性。避免使用已被滥用的前缀。
7避免思维惯性,不应当让读者在脑中把你的名称翻译为他们熟知的名称
8.类名和对象名应该是名词和名词短语,类名不应当是动词。
9.方法名应当是动词或动词短语,如save。属性访问器,修改器根据其值命名,加上前缀get,set,is。
10.给每个抽象概念选一个词,并且一以贯之。比如获得,可以fetch,retrieve,get,只选一个,并在以后的使用中一以贯之。
11.同时也不必为了强行保持一致而一以贯之,还是以易于理解为主。
12.阅读代码的人通常是程序员,如果使用计算机专业名词表达更明确的话,就使用它。
13.如果使用计算机专业名词无法命名,就从所涉及问题领域方面来命名。
14.尝试添加语境,使读者更容易理解代码。当方法提供的语境无法准确理解参数名称时,可以将该方法改编成一个类,增强语境。
15不要添加没用的语境,在所有参数名前加前缀类名相当于都没有加。
网友评论