您的位置:首页 > 编程语言

整洁代码-----有意义的命名

2016-08-08 15:41 162 查看
注:本系列主要来自日常书籍阅读

        向资深工程师请教

        个人理解

        如要转载请标明来源。

函数、类、参数等一切需要自己命名的地方。

以下方法,会对软件开发团队协作开发有重要作用,遭乱的名称,只会扯你的后腿。

1.见名知意

    不要怕名称长,但一定要让它一看就知道它是做什么的

2.避免误导

    相似含义的名称之间区别要明显

    尽量不用数字0和大写字母O,数字1和字母l

    名词缩写要注意新造词汇是否有其他含义

3.有意义的区分

    命名区分时,尽量少用:1、2、3以及无意义的词缀:结尾加s,加the 等进行区分

4.使用读的出来的名称

5.尽量少使用自造词,因为会引起误会。

6.使用可搜索的名称

    名称长短应与其作用域大小成正比。

    尽量使用好搜索的名称

7.避免使用系统变量名

    比如接口前部使用大写字母I 来当做interface的代表 

    此处我比较喜欢接口处不加I而在实现类结尾增加Impl 代表接口的实现类

    比如:phoneString,phoneNumber,phoneList 等

8.避免思维映射

    自己所了解的熟悉的名称,他人并不一定了解,所以起名时一定要起专业词汇的名称,避免起名不明确。

9.类名

    类名与对象名应该是名词或名词短语,不应当是动词。例如:Customer、Account 等

10.方法名

    方法名应为动词或动词短语。例如:postPayment、deletePage等

11.每个概念对应一个词

    要使用连贯的命名方法,比如Action、Controller、Manager 等不要一起使用,尽量使用一种。同意义的词尽量一致使用一种。

12.使用计算机领域名称

    尽量使用专业领域词汇进行命名,因为阅读你代码的人往往是专业领域人士,而且如果对方不懂,也方便去网上准确的查询。

13.使用业务领域专业名称

    如果上一条计算机专业领域词汇无法描述
8d50
,那就使用业务领域的名称,至少方便运维人员进行理解。

14.添加有意义的语境

    比如方法名:addAddress  变量名:state,street,city,houseNumber等
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: