(读书笔记)代码整洁之道-命名部分

代码整洁之道读书笔记

有意义的命名

(只是做个笔记加深记忆,并且可以时不时提醒自己)

  • 命名应该明确

    它为什么存在,它能做什么事,它怎么用
    达到在不用注释的情况下说明意义

  • 避免产生误导

    比如可能的专有词汇,看起来相近的名称,字母I,O

  • 做有意义的区分

    废话都是冗余也不要只为了满足程序运行而编码
    表名不应该存在Table 字符串不存在String 不用data info来区分

  • 使用可读的名称

    方便讨论等等~~

  • 使用便于搜索的名称

    少用数字,长变量名优于短变量名

  • 避免使用编码

    不用匈牙利语标记法,少用前缀,接口的命名尽量体现内容弱化接口
    这条不是很明白
    估计年龄大一点可能会更有体会

  • 避免思维映射

    不要让读者把你的名称读成他们认为的名词
    明确是王道

  • 类名

    –>类名应当是名词或名词短语,避免使用Data,Info,Manager等词

  • 方法名

    –>应当是动词或动词短语
    is ,get ,set

  • 别扮可爱

    避免使用俗语等等
    禁止抖机灵。

  • 每个概念对应一个词

    避免同时使用controller和manager

  • 不用双关词

    比如书之前有很多类中有add()方法,表示将两个字符串连接并得到新的字符串。这时,你写了一个新类也有一个add()方法,但是它的作用是将一个字符串存入数组。这时虽然add()也可以表达意义但是因为和之前的方法功能不同所以最好不要用add()命名,可以用insert()

  • 使用解决方案领域的名称

    就是说看代码的都是程序员,所以说尽量使用计算机专业的术语而不是业务术语。

  • 使用问题领域的名称

    就是说如果不能用程序员熟悉的术语表达,有用业务术语

  • 添加有意义的语境

    就是说通过类名,方法名,变量名等一系列的标准命名来构建一个语境,提高名称识别度。

  • 不添加没用的语境

    基本上还是明确是王道,不要乱加定词和冠词

posted @ 2016-09-01 14:26  线团  阅读(284)  评论(0编辑  收藏  举报