代码整洁之道笔记1

一.整洁代码
整洁代码的一些特征

代码逻辑应该直接了当，叫缺陷难以隐藏；

尽量减少依赖关系，使之便于维护；

依据某种分层战略完善错误处理代码；

性能调至最优，省得引诱别人做没规矩的优化，搞出一堆混乱来；

整洁的代码只做好一件事；

有单元测试和验收测试；

有意义的命名；

尽量“少”；

两条重要原则：

尽量让代码易读，开发时减少读的时间。

童子军军规：“让营地比你来时更干净”。

二.有意义的命名
名副其实

避免误导

1.程序员必须避免留下掩藏代码本意的错误线索，应当避免使用与本意相悖的词

2.以同样的方式拼写出同样的概念才是信息，拼写前后不一致就是误导

3.要注意使用小写字母i和大写字母O作为变量名，看起来像“壹”和“零”

做有意义的区分

1.不同东西意义不一样时，一定要在命名上区分，如变量，不要简单的cat1，cat2这样区分

命名读得出来，单词可搜索

避免使用编码

1.不要乱用前缀

避免思维映射

1.明确是王道，不要让人需要想象或者产生联想

类名是名词或名词短语，方法名是动词或者动词短语

别扮可爱

别用双关语

1.避免将同一单词用于不同目的

2.应尽力写出易于理解的代码，把代码写得让别人能一目尽览而不必殚精竭虑地研究

使用解决方案领域名称，使用源自所涉问题领域的名称

添加有意义的语境

1.你需要用有良好命名的类、函数或名称空间来放置名称，给读者提供语境

2.如果没这么做，给名称添加前缀就是最后一招了

不要添加没用的语境

1.只要短名称足够清楚，就要比长名称好

最后的话

1.取好名字最难的地方在于需要良好的描述技巧和共有文化背景