Java命名规范

Java总体命名规范

1. 项目名全部小写；
2. 包名全部小写；
3. 类名首字母大写，若类名由多个单词组成，则每个单词的首字母大写；
4. 变量名和方法名首字母小写，若名称由多个单词组成，每个单词的首字母大写；
5. 常量名大写。
   所有命名规则必须遵循以下原则
   1、名称只能由字母、数字、下划线、$符号组成；
   2、不能以数字开头；
   3、名称不能是Java中的关键字；
   4、不允许使用中文命名。

Java包名命名规范

Java的包名全部小写，包的路径的定义应该符合所开发的系统模块的定义，为了方便后期可直接通过包名得知相应类属于哪个模块
常规包名
1、公司包名
    com.公司名.项目名.模块名…
2、团队项目
    team.团队名.项目名.模块名…

注释规范

1、类注释
注释模板如下：
/**
*Copyright©,2017-2021
*FileName:xxx.java
*类的详细说明
*
*@类的创建者姓名
*@创建日期
*@version
*/

2、属性注释
注释模板如下：
/*注释内容/

3、方法注释
注释模板如下：
/**
*方法的详细使用说明
*
*@param 参数的使用说明
*@return 返回结果的说明
*@throws 异常类型.错误代码 注明从该方法中抛出来的异常说明
*/

4、构造方法注释
注释模板如下：
/**
*构造方法的详细使用说明
*
*@param 参数的使用说明
*@throws 异常类型.错误代码 注明从该方法中抛出来的异常说明
*/

5、方法内部注释
注释模板如下：
//注释内容