邀请你给一个按钮命名
每个 coder 都有自己的编码习惯,举个小例子:
你会给一个登录按钮的控件ID,怎么命名?
- btnLogin
- btLogin
- btn_login
- loginButton
- loginBtn
- denglu
- 等等
我的习惯是 btnLogin,你是哪种 style 呢?
标准很重要
开发公司的一个老项目时,项目迭代历史悠久,从命名风格中可以看到不少开发人员的痕迹,一个类文件中,各类命名,简直逼死强迫症,相信很多老项目都有这种历史遗留问题。当然,此刻同样是在创造以后的历史,小团队,就算职位只配备一个开发人员,可以避免这些问题,当有多个开发人员合作开发时,统一开发规范很重要,否则这个问题会一直继续。
那问题就来了,如何制定一个标准?并且这个标准需要被整个团队认可,才能开心地执行下去。
想要说服别人放弃自己的风格,接受自己的命名风格,是有一定难度的事情。例如我喜欢 btnLogin,我的搭档喜欢 loginBtn,我说,你的命名不好,要按我的来,十有八九会被怼回来。那这么问题怎么解决呢,有两个方案:
- 和搭档深入沟通,制定一个规范。
- 找一个目前流行的编码规范。
推荐一个规范手册
如果你选择方案二,我想为你推荐一个很权威的编码规范:《阿里巴巴Java开发手册》。这个开发手册是阿里巴巴出品,品质值得信赖,接受和认可度很高,无论是现在还是以后的开发人员,都很容易被认可。同时,最重要的是,为了更好的检测规范的执行,后继还推出了代码规约的插件,Android Studio 可以搜索安装插件 Alibaba Java Coding Guidelines 。
手册中针对规范,做了强制和推荐的等级划分,并且例举出正例和反例,非常清晰明了。
这里写图片描述手册内容简洁易懂,一个小时内能看完,开发中配合插件使用,体验超棒!插件有两种检测模式,实时检测和手动检测。前者在开发过程中随时提醒我们注意规范,后者适用于在排查项目的整体规范执行。
针对违反规约行为会有不同的提示,强制级别会爆红,推荐级别会警告,提供详细的修改说明,帮助正确规范代码。
这个是一个强制规范:
这里写图片描述
这个是一个推荐规范:
这里写图片描述这是手动检测结果:
这里写图片描述部分错误提供了 QuickFix 功能,支持一键修复(上图右上角的小灯泡提示就是),十分贴心有没有?!
现在永远也不晚
《阿里巴巴Java开发手册》手册正式向外发布为 2017.2.9 ,IDE 代码规约检测插件开源时间为 2017.9.25 。现在是 2018.7.25,非常迟到的尝试。但现在永远不会晚,努力变的更好吧。
无规矩不成方圆,无规范不能协作。还没有形成自己规范的小伙伴们,可以尝试起来啦。
PS:后台回复「代码规范」,可以获取一份《阿里巴巴Java开发手册》哈。
欢迎关注博主的微信公众号,快快加入,期待与你一起成长!