Java项目命名规范

文章目录

一、项目名
二、包名
三、类名、接口名
四、方法名
五、变量名
- 一、普通变量名
- 二、常量名（静态变量名）
六、属性文件properties
七、数据库命名：
八、注释规范
重点

一、项目名

所有单词全部用小写，如testjavaproject、studentmanagement等

二、包名

全部小写，名词。如：java.awt.event。

三、类名、接口名

首字母大写，多个单词组成时，每个单词的首字母大写。如：

java 复制代码

public class MyClass {}

四、方法名

首字母小写，多个单词组成时，从第二个单词开始，每个单词的首字母大写。第一个单词一般为动词，如：

java 复制代码

public void toString() {}

五、变量名

一、普通变量名

同方法的命名，一般为名词。如：

java 复制代码

int index=0;

二、常量名（静态变量名）

全部大写。如：

java 复制代码

public static final String GAME_COLOR="RED";

六、属性文件properties

以下划线隔开。如：errors_zh_CN.properties，hibernate_test.properties

七、数据库命名：

表、字段命名全部大写，多个单词以_隔开

八、注释规范

一、类注释

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

java 复制代码

/**
* Copyright (C), 2006-2010, Anhui Love info. Co., Ltd.
* FileName: Test.java
* 类的详细说明
*
* @author 类创建者姓名
* @Date    创建日期
* @version 1.00
*/

二、属性注释

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

java 复制代码

/** 提示信息 */
private String strMsg = null;

三、方法注释

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

java 复制代码

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

四、构造方法注释

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

java 复制代码

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

五、方法内部注释

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

java 复制代码

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

重点

类名不能是关键字

关键字不能用于变量名、方法名、类名、包名

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

2)、不能以数字开头

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

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

参考文章的连接如下：

https://blog.csdn.net/chao2016/article/details/79370658

https://www.cnblogs.com/superfly123/p/10446805.html