随着《阿里巴巴Java开发手册》的公开,重新又掀起一股编码规范的风口。结合《华为java编程规范》以及团队内部的实践,我们也做了一段开发规范。不求最全,但求有效。

里面的规范,暂时只分两类。“强制”,即如果违反就不能使用级别。比如说,在codereview有遇到 ,那就会直接把pull request打回去,拒绝合并到开发者稳定分支上。“推荐”,即建议怎么做,但是不强制,根据不同的水平可以做一些参考。

通用规范

所有的情况下都通用

1、 【强制】命名全部使用英文,禁止中文或者中英混合。项目名除外,因为有的项目是按域名来命名的,域名本身有可能是中文拼音。

例子

域名:kecheng.xxx.com项目名:xxx-web-kecheng

2、 【强制】禁止使用缩写,除非提供一个缩写列表

反例

# 这里的t到底是什么意思?topic_id?还是teacher_id?字段:t_id

3、 【强制】禁止出现除了后缀或者前缀3个单词。如果超过3个,说明想表达的职责太多,可以拆分或者封装。

编程语言

这里主要指的是Java语言,其他的语言也可以借鉴这些准则

1、 【强制】需要有统一的后缀或者前缀。为了一看类名,就知道这个类干什么的。

前缀列表:

  • 抽象类(Abstract)

  • 接口(I)

网友评论