java命名和注释规范总结

一、总体规则

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

2)、不能以数字开头

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

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

---

二、具体约定

1、 项目名小写

2、 包名小写

3、 类名首字母大写，每个单词的首字母大写。

public class MyClass{}

4、 变量名、方法名首字母小写，每个单词的首字母大写。

private String myPictureIntro;
public void toString(){}

5、 常量名全部大写

public static final String PIC_NAME=”ONE”;

---

三、注释规范

1、   类注释

每个类前：

/**
* Copyright (C), 2016-2019, Lucas info..., Ltd.
* FileName: MyFirst.java
* 类的说明
* @author 类创建者姓名
* @Date    创建日期
* @version 1.00
*/

2、   属性注释

每个属性前面：

/** 属性意义 */
private String myMsg = null;

3、   方法注释

每个方法前：

/**
* function的介绍
* @param 参数1 参数1解释
* @param 参数2 参数2解释
* @return 返回结果的说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/

4、   构造方法注释

每个构造方法前：

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

5、   方法内部注释

//背景颜色
Color bgColor = Color.RED