clean code读书总结和思考2

3.注释
不要对差的代码增加注释，而是要去重构它。
代码是最新的，而注释未必是最新的。所以会误导读者，从而使整个系统一片混乱
原则
1. 选择写干净的代码，而不是为差的代码添加注释。这样会越来越糟
2. 用代码来描述你的想法，而不是注释。选择好的命名和组织合理的方法
3. 最好的注释就是没有注释。先保证在没比写注释更好的方法时才选择用注释来补充说明，同时更要注意保证注释的正确性
4. 好的注释能表达更深层次的思想，有利于代码的理解。
5. 注释能提供一些警示或强调信息，//TODO,//FIXME等便于查找关键点
6. 如果注释是多余的，形而上学的，选择毫不犹豫的去掉它。
7. 不用写日记式的代码跟踪记录，因为这会让你的代码臃肿。同时借助版本控制，可以很好的完成代码管理的重任
8. 注释应该写在合适的位置，注释合适的对象。如果距离过大就会给人造成困扰。同时注释内容也不宜过多。

实践
1. 尽量写好代码，花些实践在命名和方法上，而不是给差代码写注释
2. 如果必要写一些关键的说明文字，方便读者理解，特别是一些思维的跳跃点。
3. 确保注释和代码的同步




4.格式化
原则
1. 格式化的目的是为了可读性，组织得当，条理清晰。
2. 类不宜太长，最好不要超过500行
3. 方法的顺序和调用的顺序相关，可以符合逻辑的阅读
4. 紧密关联的东西不要隔开，而隔开那些不是紧密关联的代码
5. 变量的申明应靠近它使用的地方
6. 实例变量应定义在类名的开头
7. 每行的代码的长度不要超过120即可
8. 用好缩进，特别是嵌套语句，很能提高可读性
9. 每个团队应该有个一致的规则
10. 平时多用用格式化工具 ctrl+shilf+f

实践
1. 平时多注意代码质量，用好工具，多用工具
2. 设立一个符合团队的标准