干掉你代码中的坏味道

如需转载请联系听云College团队成员小尹 邮箱：yinhy#tingyun.com

最近团队开始抓代码质量了，总结一下自己的经验，先看看坏代码有哪些特点：

1.png

“都一样,不幸的家庭却各有不同”，这句话放到代码里也同样适用。接下来，我们聊一聊如何解决坏代码问题。 


如果我问你，“你们是如何保证团队代码质量的”，你的回答可能是：“我们每次写完代码，都会花一些时间review一下。” 


恩，做的确实不错，但是，做的还不够，除非你是门门考试都100的学霸，否则，借助一些工具还是比较稳妥的办法。 


在这里简单介绍一个代码分析工具RubyCritic，这是一个专门针对Ruby的一个静态代码分析工具。其它语言的，也有相似功能的工具链，我就不做介绍了。 


这是一个命令行工具,第一步就是添加到你的gem库中，当然，还可以使用guard自动化分析。（Ruby的世界，你懂得~） 第二step，在console运行【RubyCritic】命令，就像这样：  

2.png

在命令的最后，会生成一个静态页面。长这个样子：  

3.png

x轴代表改动频率，Y轴代表代码复杂程度 


这是分析结果的overview，超过200的复杂度的，基本都是坏代码。 


再看看code里的内容： 

4.png

对不同文件按照改动频率、复杂度、重复度和坏味道4个维度进行综合评定代码质量等级（和美国考试的成绩打分规则一样）。  


再看看Smell里的内容 ： 

5.png

6.png

7.png

8.png

RubyCritic对代码分析的原理，其实就是分析一些，被它认为是坏代码的点。注意，我这里使用的措辞是“被它认为，所以，有时候，它不是绝对的正确。” 还可以查看具体的类文件中的代码质量问题。

9.png

更多的介绍，详见 https://github.com/whitesmith/rubycritic  


下面，我们针对RubyCritic