Java项目命名规范参考

 更新时间:2023年11月10日 09:25:18   作者:seven_stars_  
在实际项目开发中,命名规范的遵守可以提高代码的可读性和可维护性,本文就来介绍一下Java项目命名规范参考,具有一定的参考价值,感兴趣的可以了解一下

一、项目名

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

二、包名

全部小写,名词。如:java.awt.event。

三、类名、接口名

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

public class MyClass {}

四、方法名

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

public void toString() {}

五、变量名

一、普通变量名

同方法的命名,一般为名词。如:

int index=0;

二、常量名(静态变量名)

全部大写。如:

public static final String GAME_COLOR=”RED”;

六、属性文件properties

以下划线隔开。如:errors_zh_CN.properties,hibernate_test.properties

七、数据库命名:

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

八、注释规范

一、类注释

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

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

二、属性注释

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

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

三、方法注释

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

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

四、构造方法注释

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

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

五、方法内部注释

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

//背景颜色
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

到此这篇关于Java项目命名规范参考的文章就介绍到这了,更多相关Java 命名规范内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Struts拦截器实现拦截未登陆用户实例解析

    Struts拦截器实现拦截未登陆用户实例解析

    这篇文章主要介绍了Struts拦截器实现拦截未登陆用户实例解析,分享了相关代码示例,小编觉得还是挺不错的,具有一定借鉴价值,需要的朋友可以参考下
    2018-02-02
  • java事务回滚失败问题分析

    java事务回滚失败问题分析

    这篇文章主要介绍了java事务回滚失败问题分析,具有一定借鉴价值,需要的朋友可以参考下
    2018-01-01
  • java设计模式之观察者模式

    java设计模式之观察者模式

    这篇文章主要为大家详细介绍了java设计模式之观察者模式的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-12-12
  • javaCV视频处理之提取人像视频

    javaCV视频处理之提取人像视频

    这篇文章主要介绍了利用JavaCV实现提取视频中的人像并保存为视频,文中的示例代码讲解详细,对我们学习JavaCV有一定的帮助,需要的可以参考一下
    2021-12-12
  • 基于spring+springmvc+hibernate 整合深入剖析

    基于spring+springmvc+hibernate 整合深入剖析

    这篇文章主要介绍了于spring+springmvc+hibernate整合实例,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-10-10
  • SpringBoot集成Spring Security用JWT令牌实现登录和鉴权的方法

    SpringBoot集成Spring Security用JWT令牌实现登录和鉴权的方法

    这篇文章主要介绍了SpringBoot集成Spring Security用JWT令牌实现登录和鉴权的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-05-05
  • nohup运行Java tail查看日志方式

    nohup运行Java tail查看日志方式

    nohup命令允许程序在用户退出账户或关闭终端后继续运行,常与"&"结合使用以实现程序的后台执行,配合重定向操作,nohup可以将程序输出保存到日志文件中,如nohup java -jar XXX.jar &> myout.log &,此外,tail命令可用于实时监控日志文件的变化
    2024-09-09
  • SpringCloud如何引用xxjob定时任务

    SpringCloud如何引用xxjob定时任务

    Spring Cloud 本身不直接支持 XXL-JOB 这样的定时任务框架,如果你想在 Spring Cloud 应用中集成 XXL-JOB,你需要手动进行配置,本文给大家介绍SpringCloud如何引用xxjob定时任务,感兴趣的朋友一起看看吧
    2024-04-04
  • SpringMVC @ResponseBody 415错误处理方式

    SpringMVC @ResponseBody 415错误处理方式

    这篇文章主要介绍了SpringMVC @ResponseBody 415错误处理方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11
  • Springboot @Value获取值为空问题解决方案

    Springboot @Value获取值为空问题解决方案

    这篇文章主要介绍了Springboot @Value获取值为空问题解决方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-02-02

最新评论