Java命名规范

命名规则

名称只能有字母，数字，下划线(_)，美元符($)组成；名称不能以数字开头；名称不能使用Java关键字；名称中不能包含中文。

命名规范

项目名要全部小写；

包名要全部小写；

类名要首字母大写，如果类名由多个单词构成，则每个单词的首字母都要大写，如：

public class HelloWorld{ }

变量名、方法名首字母小写，如果由多个单词构成，则每个单词的首字母都要大写，如：

int num; //变量名 public void getUserMessage(){ //方法名 }

常量名要全部大写，如：

public static final String PAGE_COLOR = "RED";

所有名称命名时必须遵循Java命名规则。

注释规范

注释类型

Java支持两种注释方式，单行注释和多行注释。

//这是Java的单行注释 /*这样写单行注释也可以*/ /** *这里 *是 *Java的 *多行注释 */

类、接口注释

一般使用多行注释，模板如下：

/** *Author:开发者 *Email:开发者邮箱 *Description:类或接口的功能描述 *Date:创建时间 */

方法注释

整体方法注释：采用多行注释

/** *功能描述 *@params 说明参数含义 *@return 说明返回值含义 */

内部注释：方法内部采用单行注释数（注释与代码对齐，*和//与文本间空一个空格）

变量注释

变量注释采用//在变量后添加注释，如果注释过长，可在变量上方添加。