文档详情

JAVA代码规范之珍藏版.doc

发布:2025-05-15约1.05万字共16页下载文档
文本预览下载声明

AvenJAVA代码标准为标准代码结构,增加代码可读性,提高开发效率,编写此文档。梦通网络科技开展

Aven

JAVA代码标准

为标准代码结构,增加代码可读性,提高开发效率,编写此文档。

梦通网络科技开展

TOC\o1-3\h\z\u11046一.Java文件声明顺序 2

6965二.注释标准 2

58781.文件注释 3

112902.类注释 3

201983.方法注释 4

34674.重载方法注释 4

131685.委托方法注释 4

223876.属性注释 5

145357.方法内注释 5

16738三.排版标准 5

91471.单行代码长度 5

169972.缩进 5

99113.换行 5

175384.语句划分 6

10186四.命名标准 6

125861.包命名 6

327252.类命名 6

15653.接口命名 6

174984.方法命名 6

242145.变量命名 6

308416.常量命名 7

314217.其他命名 7

100138.关于ext局部的命名 7

24488五.语句标准 7

14196六.编码标准 8

154821.访问控制 8

56562.静态属性及方法访问 8

259513.变量赋值 8

247294.多路分支 8

316005.JDBC 8

282336.对象属性方法 8

206867.常量 8

103648.函数参数 8

211049.函数有效代码行数 9

3009410.返回值 9

1982711.推荐链式编码风格 9

2188112.防止交叉引用 10

21494七.编码原那么 10

9621.针对接口编程而不是针对实现编程 10

260532.优先使用〔对象〕组合而不是〔类〕继承 10

209843.单一职责原那么 12

254354.开放封闭原那么 12

182175.里氏替换原那么 12

179326.逆向依赖原那么 12

132967.接口隔离原那么 12

一.Java文件声明顺序

类或接口应该按以下顺序声明:

包的定义

impot类〔输入包的顺序、防止使用*〕

输入包应该按照java.*.*,javax.*.*,org.*.*,com.*.*的顺序import

在import的时候不应该使用*(例如:java.util.*)

类或接口的定义

静态变量定义,按public,protected,private顺序

实例变量定义,按public,protected,private顺序

构造方法

方法定义顺序按照public方法(类自己的方法),实现接口的方法,重载的public方法,受保护方法,包作用域方法和私有方法。

建议:类中每个方法的代码行数不要超过100行。

内部类的定义

二.注释标准

点击window的preferences,到下面页面增加注释模板

Javacodestylecodetemplates

1.文件注释

/**

*@Title:${file_name}

*@Package${package_name}

*@Description:

*@工程:--工程名称--

*@创立人:${user}

*@创立日期:${date}${time}

*@修改人:

*@修改日期:

*@修改原因:

*@version:

*/

2.类注释

/**

*@ClassName:${package_name}.${type_name}

*@Description:

*@创立人:${user}

*@创立日期:${date}${time}

*@修改人:

*@修改日期:

*@修改原因:

*@version:

*${tags}

*/

3.方法注释

/**

*@Title:${enclosing_method}

*@Description:

*${tags}

*@see${package_name}.${enclosing_type}.${enclosing_method}

*@创立人:${user}

*@创立时间:${date}${time}

*@修改人:

*@修改原因:

*@修改时间:

*@版本:

*/

4.重载方法注释

/**

*@Title:${enclosing_method}

*${see_to_overridd

显示全部
相似文档