代码整洁之道

代码整洁之道

第二章 变量

1. 有意义的命名，int i不好
2. 避免误导 如0和o,1和l
3. 有意义的区分，看的出来意义，不要与其他重合
4. 使用读的出来的名称，不要自造词
5. 使用可搜索的名称，一个数或者一个字母搜索起来十分费劲
6. 避免使用编码，把类型或作用域编进名称里，徒然增加负担
7. 类名和对象应该是名词或名词短语，方法名应当是动词或动词短语
8. 别用双关语，例如add可以变成insert或者append
9. 使用所涉问题和解决问题领域的名称
10. 提供语境，便于理解名称

第三章 函数

1. 函数第一条规则就是要短小
2. 函数应该只做一件事
3. 使用具有描述性的名称，不要害怕长名称
4. 函数参数一般不要超过两个
5. 如果需要三个以上的参数，要考虑将其封装为类
6. 使用异常代替错误码，try-except
7. 减少重复

第四章 注释

1. 不准确的注释不如没有注释
2. 注释不能美化代码
3. 好注释
   • 提供信息的注释，但最好通过函数名传达
   • 对意图的解释，提供后面的意图
   • 阐释，对晦涩的语句解释
   • 警示，警示某些情况可能出现的后果
   • TODO，想要做还没做的代码
4. 坏注释
   • 喃喃自语
   • 多余的注释
   • 误导性注释
   • 日志式注释
   • 废话注释
   • 括号后面的注释
   • 归属和署名
   • 注释掉的代码(用版本控制替代)

第五章 格式

1. 空白行隔开概念
2. 关系密切的概念应该互相靠近

• 剩余部分用不到也看不懂以后再说