J2EE项目代码规范文档.docx

《J2EE项目代码规范文档.docx》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、J2EE项目代码规范文档版本<1.2>1/14修订历史记录日期版本说明作者20XX-12-5<1.0><创建>王悦邦20XX-12-6<1.1><修改>王悦邦20XX-07-15<1.2><修改>苏谟目录1.Java文件名与文件组织结构2矚慫润厲钐瘗睞枥庑赖賃軔朧。2.Java文件注释头33.包的声明与引用34.类与接口的声明45.Java源文件编排格式45.1.代码行长度与折行规则45.1.1.代码行长度45.1.2.折行规则55.2.程序注释55.2.1.程序实现代码注释55.2.2.注释规则95.3.变量的声明初始化与放置错误！未定义书签。5.3.1

2、.变量声明错误！未定义书签。5.3.2.变量初始化105.3.3.变量放置106.Java程序语句编写规则116.1.简单语句116.2.复合语句117.空格与空行的应用规则137.1.空格的应用规则137.2.空行的应用规则138.方法、变量与常量的命名规则138.1.方法的命名规则148.2.变量的命名规则148.3.常量的命名规则14序通常说来优秀的开发人员一般都有良好的程序设计风格，优秀的管理人员会在自己的开发团队中灌输养成良好程序设计风格的意识，优秀的软件企业都有自己一套健全、成熟的程序设计风格规范文档，用以规范开发人员编写代码的风格。聞創沟燴鐺

3、險爱氇谴净祸測樅。定义这个规范的目的是让项目中所有的代码、文档都具有统一的风格，增加程序的可读性，减少项目组中因为任务移交等原因造成的时间浪费，提高代码的可维护性。残骛楼諍锩瀨濟溆塹籟婭骒東。Java文件名与文件组织结构Java文件名由实意文件名+后缀组成，后缀名因类型的不同而不同。如表1-1所示。表1-1后缀名的意义文件类型后缀名Java源文件.javaJava字节码文件.class一般说来Java源文件的结构是这样的，每一节代码之间是由一个空行分割开的，并且每一节都有相应的注释，通常来讲一个java源文件不应该超过20XX行，否则就是视为类“臃肿”，这

4、种情况在程序设计时，应该尽量避免。酽锕极額閉镇桧猪訣锥顧荭钯。每一个Java源文件一般由下面的顺序构成：（1）文件注释头2/14（2）包名（package）（3）引入（import）声明（4）类（class）或接口（interface）的声明部分Java文件注释头Java类文件注释头是用来描述该类功能及其特点，以及相关开发信息的，如该类的关联类（通常情况下不描述Java系统核心类如java.util.Vector,java.lang.Thread等）、开发公司或单位、版权、作者、代码审定人该类所支持的JDK版本、该类版本、开发日期、最后更改日期、修改人、复

5、审人等信息。主要用到的注释有：彈贸摄尔霁毙攬砖卤庑诒尔肤。@see使用格式@see+空格+类名（不能带.java）@version版本号@author作者@since自从（标识类从什么版本开始使用比如：2.0版本新增类，可以使用这个注释进行说明）@date开发日期*继承，实现接口，被继承，会自动生成下面就是一个Java类文件注释头：/****************************************************************謀荞抟箧飆鐸怼类蒋薔點鉍杂。*该类功能及其特点的描述（例如：该类是用来实现页面调转）**该类经编译

6、测试过**@see（与该类相关联的类）：（例如：SgJbxx.java）***开发公司或单位：中科院沈阳计算所有限公司西南信息中心**版权：本文件版权归属中科院沈阳计算所有限公司***@author（作者）：王悦邦**@since（该文件所支持的JDK版本）：JDK1.6**@version（版本）：1.0**@date（开发日期）：20XX-9-6**最后更改日期：20XX-12-6**修改人：王悦邦**复审人：**************************************************************厦礴恳蹒骈時盡继價骚

7、卺癩龔。文件注释头包括@see,@author,@since,@version,@date等标记，是为了通过jdoc声称JavaAPI标准文档做准备的。茕桢广鳓鯡选块网羈泪镀齐鈞。包的声明与引用我们在做Java开发时常会引用（import）Java核心类或者第三方软件厂商的类，一般情况下，这些类都是封装在一个包（package）里面的，包概念的出现，使类（class）有了名称空间的细致划分，使庞大复杂的类群有了较为清晰的分支，形成了清晰脉络。包的另一个作用就是可以将同名的类（class）或接口（interface）分离开来，不至于产生二义性或以假乱真的错误

8、。鹅娅尽損鹌惨歷茏鴛賴縈诘聾。3/14下面给出了包的基本命名规则，