代码规范-《代码整洁之道》的读后感

注释:
1、好的名字比注释更重要
2、给常量加注释
3、在类级别使用全局注释来解释所有部分如何工作
4、团队统一标记
5、注释应申明代码高层次意图,而非明显细节
6、不要添加代码的著作信息,git可以干的事情不要交给代码
7、真正的好注释是你想办法不去写的注释
 
命名:
1、尽可能的使用标准命名方法
2、命名要找更有表现力的词
3、变量名称长短应该与其作用域对应
4、别害怕长名称,长而具有描述性的名称比短而费解的名称好
 
方法:
1、函数20行封顶最好,不应该写太长
2、最理想的参数是零参数,最长不要超过三个入参,尽量不要输出参数
3、别返回或传入null,或返回特殊对象
 
异常与错误:
1、将try包含的代码块抽象成一个函数
2、对待每一个异常都需要详细处理,不能归咎成偶然事件
 
单元测试:
1、不要怕繁琐,测试名字和方法应尽量详细
2、不要追求太高的测试覆盖率,测试代码前面90%通常比后面10%花的时间少
3、使用简单的能够完整运行的代码测试输入
4、测试代码与生产代码一样重要
5、测试代码一样需要整洁
 
代码结构:
1、代码行长度控制在100-120个字符
2、关系密切的代码应该互相靠近
3、提早返回可以减少嵌套并让代码整洁
 
设计:
1、类应该足够短小
2、减少变量的数量来让代码更有可读性
3、最好的代码就是没有代码,消除不必要的功能
4、设计尽可能简单,不可重复代码内容

猜你喜欢

转载自www.cnblogs.com/caibaofei/p/9111195.html