1.简介
接手前同事的代码一段时间了,看得我真心难受。没有注释,各种奇怪的命名,比如你能看到一个类里面出现getSetCache和getCacheSet两个方法,传参也不同,(我也不知道这个人是不是方法重载都没学过),根本不知道他想干啥。。。
--------------------------------------------------------吐槽后的分割线----------------------------------------------------------------------------
这是我们群里一位大佬说的,这个人光是头像都让我们觉得是位深不可测的大佬,哈哈哈。
哪怕错误连连,规范的代码会让人看起来舒服。改起来也省时省力。
2.阿里代码规范
阿里作为我们IT界的老大,主打java,2018年9月22日,在2018杭州云栖大会上,召开《码出高效:Java 开发手册》新书发布会,并宣布将图书所有收益均捐赠于技术公益项目“83行代码计划”。
他们有一份很详细的编码规范pdf。
这份呢,emmmmmm。我觉得我们看了也未必记得住,所以阿里大佬们专门为我们这些“记性不是很好”的开发了一个扫描工具,只要集成到编码工具里,可以自动帮我们扫描不规范的代码。
链接:https://github.com/alibaba/p3c/tree/master/idea-plugin
上面的链接是idea这个工具的代码规范扫描工具,如果需要其它工具,在它的上级目录可以找到
同时,它还提供给我们编码规范的pdf
3.使用
安装和使用都非常简单,并且在github也有教程
这里以IDEA为例子
https://github.com/alibaba/p3c/blob/master/idea-plugin/README_cn.md