代码的命名规范,简易版

  1. 命名规范:

包(Package):

1. 使用小写英文字母进行命名。

2. 多层包之间用点进行分隔。

3. 一般采用域名倒写的方式进行命名。

package com.zer.controller

类(Class)与接口(Interface):

1. 通常是见名知意的名词。

2. 首字母大写

3. 多个单词时,采用驼峰命名法。

public class UserController{}

抽象类(Abstract Class):

1. 符合类名的命名规范即可。

2. 为了和接口做出区别,一般以“Abstract”或“Base”作为前缀。

public abstract class AbstractController{}

异常类(Exception Class):

1. 符合类名的命名规范即可。

2. 为了和普通类做出区别,一般以“Exceptiont”作为后缀。

public class FileNotFoundException{}

接口实现类:

1. 符合类名的命名规范即可。

2. 为了和普通类做出区别,一般以“Impl”作为后缀。

public interface UserService{}

public class UserMapperImpl implements UserService{}

测试类:

1. 符合类名的命名规范即可。

2. 为了和普通类做出区别,一般以“Test”作为后缀。

public class UserServiceTest{}

方法(Method):

1. 通常是见名知意的名词。

2. 首字母小写。

3. 多个单词时,采用驼峰命名法。

4. 不建议使用中文缩写来命名。

5. 不建议使用下划线作为连接。

6. 有返回值的方法一般加“get”前缀。

7. 设置的方法一般加对应的动词作为前缀(如:set、insert、update、delete)。

8. 查询的方法一般加“select”或“find”或“query”作为前缀。

9. 带有条件的方法一般在命名中使用“by”或“with”等字符。

10. 判断的方法一般以“is”作为前缀。

11. 测试方法一般以“test”作为前缀。

变量:

1. 通常是见名知意的名词。

2. 首字母小写。

3. 多个单词时,采用驼峰命名法。

4. 不建议使用中文缩写来命名。

5. 不建议使用下划线作为连接。

常量:

1. 通常是见名知意的名词。

2. 全部大写字母。

3. 多个单词之间使用“_”进行分隔。

4. 不建议使用中文缩写来命名。

public static final int MAX_AGE = 120;

public static final String USER_TYPE_VIP = "会员用户";

public static final long MAX_NUMBER = 10000;

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值