Java项目命名规范

文章目录


一、项目名

所有单词全部用小写,如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

相关推荐
boy快快长大4 分钟前
【IntelliJ IDEA】插件分享
java·ide·intellij-idea
小蒜学长13 分钟前
校园外卖点餐系统(代码+数据库+LW)
java·数据库·spring boot·后端
翻滚丷大头鱼24 分钟前
Java设计模式之结构型—代理模式
java·设计模式·代理模式
ByteBlossom31 分钟前
Java集合源码解析之LinkedList
java·开发语言
青鱼入云32 分钟前
【面试场景题】1GB 大小HashMap在put时遇到扩容的过程
java·数据结构·面试
mask哥41 分钟前
DP-观察者模式代码详解
java·观察者模式·微服务·设计模式·springboot·设计原则
幸幸子.44 分钟前
实验2-代理模式和观察者模式设计
java·开发语言
追寻向上1 小时前
睿联科技2026年秋招内推
java·python·科技
计时开始不睡觉1 小时前
从 @Schedule 到 XXL-JOB:分布式定时任务的演进与实践
java·分布式·spring·xxl-job·定时任务
Slaughter信仰1 小时前
深入理解Java虚拟机:JVM高级特性与最佳实践(第3版)第八章知识点问答(18题)
java·开发语言·jvm