命名规范

一、命名规范

1、项目名：全小写（myproject）

2、包名：全小写(mypackage)

3、类名：首字母大写,每个单词首字母大写(MyClass)

4、变量名，方法名：首字母小写，后面每个单词首字母大写（myMethod）

5、常量名全部大写

6、命名规则如下：

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

　　2)、不能以数字开头

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

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

二、注释规范

1、类注释

/**

* Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.

* FileName: Test.java

* 类的详细说明

*

* @author 类创建者姓名
    * @Date    创建日期

* @version 1.00

*/

2、属性注释

/** 提示信息 */

private String strMsg = null;

3、构造方法注释

/**

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

*

* @param 参数1 参数1的使用说明

* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

*/

4、方法注释

/**

* 类方法的详细使用说明

*

* @param 参数1 参数1的使用说明

* @return 返回结果的说明

* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

*/

5、方法内部注释

//背景颜色

 Color bgColor = Color.RED

 

转载于:https://www.cnblogs.com/xingrui/p/8577396.html