艺术点,写代码的风格艺术点。
命名
- 变量、函数、类的命名能够准确表达其意义;
- 在上面基础上命名尽量且简单直观,若不能两全其美,则宁长其名也勿损其意;
- 不要使用匈牙利式命名;
注释
- 终极目标:无招胜有招;
- 程序员,用代码说话(注释是一种失败,说明程序的表达力不足,那还说什么呢,重构撒);
- 必要的注释可存在(如法律信息,版权信息,遵守的开源规则);
- 禁止出现如/**************/或//////////////////////////等程序分割线;
格式
- 良好的缩进和空格的使用;
- 垂直格式,自顶向下的阅读体验(函数的调用,层层深入,其定义也按照从上到下的顺序布局,不要上下跳来跳去的);
其他
- 禁止出现魔数;
- 避免使用NULL;
- 类应该短小;
- 函数没有参数最好,一个次之,二三再次,三个以上坚决避免;
- 单一职责,一个函数只做一件事情;
- 添加异常处理机制;
- 消除重复代码部分,若存在重复代码,说明抽象不足;
- 封装条件语句;
- 肯定性条件比否定性条件更具说服力;