代码规范的重要性
前不久很多公众号都在说因为代码规范性引起的血案,这事吧,我也没有太在意,好像后来证实根本不属实。但是,也说明了一个事情。代码规范真的很重要。
附带一下查询的结果,搜索关键字:码农因代码规范
代码规范,真的很重要,很重要,很重要
你说重要吧,也没那么重要,我的看法是:人嘛,越帅越好。(当然,现在的我不奢求帅,只想掉头发的速度能再慢些。)
Alibaba Java Coding Guidelines 插件
github地址:
https://github.com/alibaba/p3c
你可以下载到idea、eclipse插件。我用的是Android Studio。当然就是下载的idea插件。相关安装操作就不说了。
安装使用说明:
https://github.com/alibaba/p3c/tree/master/idea-plugin
附上一张官方的安装图:
实际案例
说归说,做归做。找了个功能打开来检查下,当你的代码不符合规范的时候,就会有一条线来提醒了。略有强迫症的我是会去看看原因的。
-
注释文档
当你的类没有注释的时候,特别是没有写作者的时候,我觉得这个作者是重点。要是代码出了问题,应该找不到人背锅吧。
-
如果代码注释了,可以从项目中移除
如果被你注释的代码,是确定没有用的,那么建议你直接从项目中移除。
-
如果注释是单行注释
如果是单行注释,建议不要注释在代码的右边。
-
抽象类的命名规范
关于抽象类,命名规范。做到看名知意。
-
抽象类里面的方法需要注释
抽象类的方法,建议给个注释,不然只看基类是不知道这个方法的意图。
当然还有其他的规范性,有个这个插件,我们不用刻意的去记忆,只要看到波浪线提示,那就去改正下,日积月累,代码也就规范了。
一起进步
如果你觉得,我写的东西对你帮助,那我会觉得很开心。如果你觉得我写的东西还需要改进,我很想听到你的建议。让我们一起进步吧。