Java中常见的命名规范

一、推荐使用驼峰式命名法

1）项目名、包名全部小写。

2）类名首字母大写，若类名有多个单词组成，每个单词的首字母都要大写。

3）变量名、方法名首字母小写，其名称若有多个单词组成，每个单词的首字母都要大写

4）常量名全部大写

二、所有命名规则需遵守：

1）名称只能由字母、数字、下划线、$符号组成

2)  不能以数字开头

3)  名称不能使用JAVA中的关键字。

4)  坚决不允许出现中文及拼音命名。

三、注释规范
1、类注释

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

/**
* Copyright (C), 2015-2019, All isMAYBE info. Snail_gogo.

* 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、方法内部注释

在方法内部使用单行或者多行注释，该注释根据实际情况添加。

如：//字体大小

       Test textSize= Test.big