整洁代码
当我们可以完善的实现一个业务需求、之后我们就需要考量代码的一个可读性和复用性,以及模块解耦。
我自己也经历过一些中中小小的工作,自己也每天生成糟糕的代码,也经历过几次系统重构工作,慢慢的体会到了在编写代码的时候自己需要遵循约定俗成的规范,尽可能的让自己的代码在下次阅读时一看就懂,包括下一位同事能够维护我的代码。
糟糕的代码
阅读本书让我想起了自己经历过的一些场景:
领导需要我们每天加班加点的完成超额的工作任务,所有给到我们测试代码的时间很少,甚至写完只会测试运行是否报错,然后就会进入冒烟环节,前面的人写的代码尽量能不动就不会动,这样让我们并不会思考业务的可信性,以及代码的设计思路是否合理。
怎么样可以写出相对于整洁代码呢?
- 逻辑直接
- 代码所作的事情,要从代码上面很直观的看出来,不要拐弯抹角。
- 系统核心设计高聚合
- 减少系统耦合度,让模块代码不东串串西闯闯。
- 减少重复代码
- 减少代码量,多进行抽象和设计。
- 减少类、方法、函数数量
- 尽量用最少的代码量和设计维度完成。
- 单元测试完善
- 通过单元测试可以直白的看出业务场景和逻辑
有意义的命名
软件中随处可见命名,我们给变量、函数、参数、类、和类库名称,我们命名,不断的命名。
既然有这么多命名要做,不妨做好它。
说起来很简单。选个好名字需要花时间,但省下的时间比花掉的多。注意命名,一旦有好的命名,就换掉旧的。
避免误导
当你看到下面的代码,你觉得你接受的类型是列表呢?还是单类呢?还是报错呢?
var userList=getUser(id);
做有意的区分
小伙伴问题来了,你能区分第一个参数和第二个参数是干嘛的吗?
public static void copyChars(char[] a1, char[] a2)
{
for (int i = 0; i < a1.Length; i++)
{
a2[i] = a1[i];
}
}
小伙伴你们再看看,这个方法应该靠谱一点点了吧
public static void CopyChars(char[] sourceArr, char[] destinationArr)
{
for (int i = 0; i < sourceArr.Length; i++)
{
destinationArr[i] = sourceArr[i];
}
}
使用读得出来得名称
当我们在项目中出现这样的代码,你一定会温习C语言的吧
var a = 0;
for(var i=0;i<10;i++){
a+=i;
}
那么说我们将代码调整一下,这样是不是就不会迷糊了。
var count=0;
for(var i=0;i<10;i++){
a+=i;
}
避免思维映射
在我们命名的使用尽量,使用大众熟知,约定成俗的命名,减少项目沟通时候存在的思维偏差。
类名应该是名词或短语
像Customer,Account,避免使用Manager,Processor,Data或者Info这样的类名。类名不应当是动词。方法名应该是动词或动词短语,如postPayment ,deletePage或Save,属性访问、修改和断言应该根据其值来命名,并加上get,set,is这些前缀。
别扮可爱
比如谁知道HolyHandGrenada 函数是干什么的,没错这个名字挺伶俐,但是不过DeleteItems或许是更好的名字。
每个概念对应一个词
并且一以贯之。
在一堆代码中有Controller,又有manager,driver。就会令人困惑。比如DeviceManager和Protal-Controller之间又什么本质区别?
别用双关语
如add、insert、append等词都有类似的意思,在使用时最好准确,而且统一。如字符串连接应该用append,而不是add。