Java编程规范

一、项目版本规范：

1、版本号命名格式：

V 主版本号.次版本号.修整版本号

a．初始版本号为V1.0.0；
b．对局部功能进行调整时，主版本号和次版本号都不变，修整版本号加 1；
c．在原有基础上增加了新的功能时，主版本号不变，次版本号加 1，修整版本号复位为0；
d．进行了重大修改或局部修正累积较多导致项目发生全局变化时，主版本号加1，次版本号复位为0，修整版本号复位为0；

2、版本号适用范围
一个项目有一个统一的版本号

3、版本号变更时机

版本号应在需求确定后开发前由项目负责人负责变更，变更后所有涉及增加或修改的类（包括：配置文件）的版本号都以此变更后的版本号为准。

 

二、程序行数规范：

1、文件行数超过1000行，应该对该文件进行按实际功能进行拆分；
2、类方法内行数超过12行，类方法应该按功能进行拆分，要保持一个方法只执行一个简单的功能；

 

三、命名规范：

1、文件、类或接口名命名规范
a、对于类或接口文件与类或接口一致，首字母大写，其他单词首字母大写
b、非类或接口文件字母全部小写，单词间用下划线间隔

2、路径或包命名规范
a、包名由com.公司名.项目名.模块名组成，全部小写，单词间用下划线隔开
b、路径名全部小写，单词间用下划线隔开

3、类字段、类方法、非静态变量命名规范
类字段、类方法、非静态变量首字母小写，之后各单词首字母大写

4、静态字段或变量命名规范
静态字段或变量字母全部大写，单词间用下划线隔开

 

四、注释规范：

1、类注释
/********************************************
 * 类简述加英文符号.或?或! <br>
 * 类详细描述……<br>
 * CreateDate: ${date}<br>
 * Copyright: Copyright(c) ${date}<br>
 * Company: 公司名<br>
 * @since 项目版本号
 * @author  创建人
 * @version 项目版本号
 *********************************************/

2、字段注释
/********************************************
 * 字段简述加英文符号.或?或!<br>
 * 字段详细描述……<br>
 * @since 项目版本号
 * <br>
 * --------------------------------------<br>
 * 编辑历史<br>
 * ${date}::创建人姓名::创建此字段<br>
 *********************************************/

3、方法（一般方法、main方法和构造方法）注释
/********************************************
 * 方法简述加英文符号.或?或!<br>
 * 方法业务逻辑详细描述……<br>
 * @since 项目版本号
 * @param 参数名 参数类型 参数描述
 * @return 返回类型 返回类型描述
 * <br>
 * --------------------------------------<br>
 * 编辑历史<br>
 * ${date}::创建人姓名::创建此方法<br>
 *********************************************/
注：
a.如果类、字段或方法已经失效，则需要引入@deprecated 此类(字段或方法)已经失效
b.如果需要参见其他类的字段或方法可以引入@see 参见的包名.类名#字段名或方法名(方法参数1,方法参数2,...)
c.如果方法throws异常，可以在方法的注释中引入@throws 异常类型 异常类型描述

4、其他创建和变更注释
/*
[编辑历史]
年月日何功能，由谁创建
年月日因何原因，做何改动，由谁授权变更，由谁进行代码变更
*/
注：对于不涉及业务逻辑的可以采取简单注释方式，如：//。。。。。。。

5、Eclipse中的文档型注释
a、类注释生成
在类的{后点alt+shift+j自动生成类注释

b、字段注释生成
在字段后点alt+shift+j自动生成字段注释

c、方法注释生成
在方法的{后点alt+shift+j自动生成方法注释

d、文档型注释生成
菜单：项目-->生成javadoc
生成 Javadoc对话框：点选私有后点下一步按钮
生成 Javadoc对话框：下一步按钮
生成 Javadoc对话框：点选在浏览器中打开生成的索引文件后点完成按钮
文档注释生成后自动打开浏览器浏览

e、设置文档型注释模板
【编辑文档型注释模板】
菜单:窗口-->首选项
首选项对话框：Java-->代码样式-->代码模板-->编辑按钮（选中自动为新方法和类型添加注释）
【导出文档型注释模板】
菜单:窗口-->首选项
首选项对话框：Java-->代码样式-->代码模板-->导出按钮
【导入文档型注释模板】
菜单:窗口-->首选项
首选项对话框：Java-->代码样式-->代码模板-->导入按钮

五、编码格式规范
1、Eclipse中的编码格式化模板设置
【编辑编码格式化模板】
菜单：窗口-->首选项
首选项窗口：Java-->代码样式-->格式化程序-->新建按钮-->新建概要文件窗口-->输入概要文件名称-->确定按钮
概要文件编辑窗口：编辑模板
【导出编码格式化模板】
首选项窗口：Java-->代码样式-->格式化程序-->编辑按钮
概要文件编辑窗口：导出按钮
【导入编码格式化模板】
首选项窗口：Java-->代码样式-->格式化程序-->导入按钮

2、Eclipse中设置Java文件保存时自动格式化
首选项窗口：Java-->保存操作-->选中对保存执行所有操作和格式化源代码以及格式化所有行

3、Eclipse中Java文件创建自动编码格式化
在Eclipse中Java文件创建时后自动按编码格式化模板中的格式创建文件