-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcoding convention
34 lines (28 loc) · 1.91 KB
/
coding convention
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
请在这里添加蜂群代码规范。
#########
1 java开发规范
1.1 命名规则
1.1.1 包命名
(a) 包名一律用小写的单词组成,不能包含有下划线;
(b) 顶级域用 com (一般是org, edu,com等);
(c) 二级域用 公司,组织名(swarmcn);
(d) 三级域用 项目;
(e) 四级域用 MVC中的相关的模块;
(f) 四级域后的没有相关的规定,可以根据系统的模块来定;
(g) 示例:org.swarmcn.user.controller
1.1.2 类命名
(a) 类名遵从每个单词的首字母大写。类名一般都是使用名词或者名词短语,不能使用动词。而且要使用意义完整的英文描述。
(b) 接口类(Interface)一般使用I开头。示例:IUserService;
(c) 实现类(implementation)一般去掉I开头,并且以Impl结尾,示例:UserServiceImpl;
(d) 枚举类(Enum)一般使用E开头。示例:EOrderType;
(e) 异常类(Exception)一般使用Exception作为结尾。示例:BusinessException;
1.1.3 方法命名
(a) 方法名采用驼峰型结构,方法名一般都与动作相关,如findUserById(int userId);
(b) 获取某一个值,一般使用getXxx(),示例: getName();
(c) 设置某一个值,一般使用getXxx(),示例: setName(String name);
(d) 返回类型是Boolean类型的,方法名一般使用” is “ 开头,示例:isConnected();
(e) 准确地控制成员方法的修饰符,不是必须使用public的,请使用protected,如果不是必须使用protected的,请使用private;
(f) 如果方法名长度超过18个字母,某些单词可以采用业内或者大家约定的缩写,以见名之意为前提,尽量短小精炼,示例:getStockInformation() 改为 getStockInfo()
1.1.4 变量命名
(a) 成员变量和局部变量名一般采用驼峰型结构。成员变量名不能和方法名相同,以见名之意为前提,尽量短小精炼;
(b) Boolean类型一般使用” is “ 开头,示例:isBusy;