Java命名及注释规范

  • 命名规范
  • 1、项目名：全部小写
  • 2、包名：必须用小写字母
  • 3、类名：大驼峰命名法 每个单词的首字母大写
  • 4、变量/属性命令：小驼峰命名法
  • 5、 常量名全部大写
  • 6、数据库的表名、字段名、列名。
  • 7、所有命名规则必须遵循以下规则：
  • 注释规范
  • 1、 类注释
  • 2、 属性注释
  • 3、 方法注释
  • 4、 构造方法注释
  • 5、 方法内部注释


命名规范

1、项目名：全部小写

2、包名：必须用小写字母

一般是域名倒过来。
com.alibaba.
com.tao
com.wl
com.xdk.

3、类名：大驼峰命名法 每个单词的首字母大写

商品分类的类：
ProductCategory

4、变量/属性命令：小驼峰命名法

首字母小写，后面的每个单词首字母大写。
定义变量描述用户名字：user name
String userName;

5、 常量名全部大写

如：public static final String GAME_COLOR=”RED”;

6、数据库的表名、字段名、列名。

单词之间用_隔开
比如：商品分类表
product_category

7、所有命名规则必须遵循以下规则：

1)、名称只能由字母、数字、下划线、$符号组成
2)、不能以数字开头
3)、名称不能使用JAVA中的关键字。
4)、坚决不允许出现中文及拼音命名。

注释规范

1、 类注释

在每个类前面必须加上类注释，注释模板如下：
/**

  • Copyright ©, 2006-2010, ChengDu Lovo info. Co., Ltd.
  • FileName: Test.java
  • 类的详细说明

  • @author 类创建者姓名
  • @Date 创建日期
  • @version 1.00
    */

2、 属性注释

在每个属性前面必须加上属性注释，注释模板如下：
/** 提示信息 */
private String strMsg = null;

3、 方法注释

在每个方法前面必须加上方法注释，注释模板如下：
/**

  • 类方法的详细使用说明

  • @param 参数1 参数1的使用说明
  • @return 返回结果的说明
  • @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
    */

4、 构造方法注释

在每个构造方法前面必须加上注释，注释模板如下：
/**

  • 构造方法的详细使用说明

  • @param 参数1 参数1的使用说明
  • @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
    */

5、 方法内部注释

在方法内部使用单行或者多行注释，该注释根据实际情况添加。
如：//背景颜色
Color bgColor = Color.RED