Friday, January 1, 2016

how to write good quality code

http://blog.xiaohansong.com/2017/08/09/high-quality-code/

为什么不推荐使用魔法值（即未经定义的常量）？：这个明显违反了信息隐藏的原则，当你将字面量直接写在代码里面时，就将信息直接暴露了，后面需要修改的时候，一旦少改了某个地方的字面量，bug就出现了。
循环依赖（即A调用B，B调用A的情况）：类或方法之间的循环依赖会破坏信息隐藏，一个很直接的影响就是在测试的时候，A，B都需要同时准备好才能进行测试，而无法mock任意一方。
使用全局变量：这个就不用说了，所有人都可以访问你的时候信息就暴露无疑了，全局变量能不用就不用。
考虑性能损失：有时候我们为了一些性能上的考虑就破坏信息隐藏原则，将一些变量全局化，这样性能提高得不多，维护成本却上升不少，完全是得不偿失。

最后总结一下信息隐藏的好处：

隐藏信息即隐藏了复杂度，降低了编程的负担。
隐藏信息即隐藏了底层变化，以便于在局部控制变化。

使用boolean值来给程序做注释

相信大家看到一个if语句有很多条件的时候都会特别头痛，因为很难理解。例如下面的例子：

1
2
3

if ( ( elementIndex < 0 ) || ( MAX_ELEMENTS < elementIndex ) || elementIndex == lastElementIndex) {
  do....
}

但如果换成下面的写法，用boolean值的名字来给if语句注释，看起来就很好理解了。

finished = ( ( elementIndex < 0 ) || ( MAX_ELEMENTS < elementIndex ) );
repeatedEntry = ( elementIndex == lastElementIndex );
if ( finished || repeatedEntry ) {
...
}

http://www.jianshu.com/p/31b21a0bf1e1

1. 打好基础

写出高质量代码，并不是搭建空中楼阁，需要有一定的基础，这里我重点强调与代码质量密切相关的几点：

掌握好开发语言，比如做Android就必须对Java足够熟悉，《Effective Java》一书就是教授大家如何更好得掌握Java, 写出高质量Java代码。
熟悉开发平台, 不同的开发平台，有不同的API, 有不同的工作原理，同样是Java代码，在PC上写与Android上写很多地方不一样，要去熟悉Android编程的一些特性，iOS编程的一些特性，了解清楚这些，才能写出更加地道的代码，充分发挥各自平台的优势。
基础的数据结构与算法，掌握好这些在解决一些特定问题时，可以以更加优雅有效的方式处理。
基础的设计原则，无需完全掌握23种经典设计模式，只需要了解一些常用的设计原则即可，甚至你也可以只了解什么是低耦合，并在你的代码中坚持实践，也能写出很不错的代码。

2. 代码标准

3. 想好再写

除非你很清楚你要怎么做，否则我不建议边做边想。
你真的搞清楚你要解决的问题是什么了吗？你的方案是否能有效？有没有更优雅简单的方案？准备怎么设计它，必要的情况下，需要有设计文档，复杂一些的设计需要有同行评审，写代码其实是很简单的事情，前提是你得先想清楚。

4. 代码重构

5. 技术债务

术债务话题太大，但就代码质量而言，我只想提一下不要因为这些债是前人留下的你就不去管，现实是没有多少机会让你从一个清爽清新的项目开始做起，你不得不去面对这些，你也没法完全不跟这些所谓的烂代码打交道。

因此我建议各位：当你负责一个小模块时，除了把它做好之外，也要顺便将与之纠缠在一起的技术债务还掉，因为这些债务最终将是整个团队来共同承担，任何一个人都别想独善其身，如果你还对高质量代码有追求的话。

作为团队的技术负责人，也要顶住压力，鼓励大家勇于做出尝试，引导大家不断改进代码质量，不要总是畏手畏脚，停滞不前，真要背锅也得上，要有担当。

6. 代码审查

7. 静态检查
8. 单元测试
9. 充分自测