《JAVA技术开发标准4075.docx》由会员分享，可在线阅读，更多相关《JAVA技术开发标准4075.docx（9页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、上海酷克信息科技有限公司 行业信息化专家（一）注注释规则则注释应该该增加代代码的清清晰度，注释出出谁在什什么时候候为什么么做了一一些事，而而不仅仅仅是做了了什么。尽尽量使用用javvadooc标志志，为类类生成文文档。Javaa中有三三种注释释方法：单行注注释符（/），块块注释符符（/* /）和文文档注释释（/* */）（1） 单行注释释符（/）/注释释符用来来对一行行代码添添加说明明型描述述，常见见使用如如下：a. 变量注释释，对变变量的定定义做出出说明，不不同的行行之间要要对齐,如下int levvel; / inndenntattionn leevellint sizze;/ ssize
2、e off taableeb. 添加在一一行代码码结尾或或一段代代码开始始用于对对代码进进行描述述if (fooo 1) / DDo aa dooublle-fflipp.elseeretuurn fallse; / Exxplaain whyy heere.（2） 块注释符符（/* */）用于注释释一段代代码或添添加多行行说明，如如：/* Heere is a bblocck ccommmentt.* Coommeent conntinnuess* 如果果该文件件不是修修改人创创建的，还还需要添添加修改改人，时时间等信信息*/（3） 文档注释释(/* */)文档注释释使用/*开开头，在在使用
3、jjavaadocc对jaava代代码制作作文当时时会自动动将代码码中的文文档注释释添加到到文档中中去。在在所有cclasss开头头和每个个方法前前都应该该加上/*/注注释，便便于自动动生成hhtmll格式的的类库指指南。（包包括但不不限于bbeanns,aactiion,forrm,ddao）对于cllasss的文档档注释应应该写在在claass申申明语句句前，并并且拥有有如下格格式：/* * TTitlle: 续期收收费请求求对象 * DDesccripptioon: 封装页页面提交交的请求求数据 * CCopyyrigght: Coopyrrighht (c) 20002* Coompa
4、any: Coo., Ltdd.* ssincce 220088-088-200 * autthorr Keevinn Qiiu * verrsioon 11.0 */publliccclasss RReneewChharggeROO （4） 方法注释释 /* * 查询询续期应应收费用用列表:查询指指定保单单号码保保单的续续期应收收费用信信息，* 如果果是修改改，还应应注明修修改人及及修改时时间 * pparaamsPPoliicyCCodee 保保单号码码 * rretuurn Colllecctioon oof RReneewChharggeVOO 应收收费用信信息列表表 * tthroo
5、ws Exccepttionn 所有有发生可可能的异异常 */publlic Colllecctioon ggetRReneewChharggeLiist(Strringg sPPoliicyCCodee) tthroows Exccepttionn;注释开始始是对方方法的描描述。PParaam是对对参数的的描述，rretuurn是是返回类类型的描描述,tthroows是是对抛出出异常的的描述。严格按照照文档注注释的规规范写出出完整的的注释后后，程序序生成的的HTMML类库库指南就就很详细细，方便便其他使使用该类类的程序序员查阅阅和使用用。（二）BBEANNS定义义规范1、字字段名称称的取法法
6、符合规规范，详详细情况况以数据据字典为为准，一一般采用用英文去去掉元音音后的三三字母简简写，例例如，ccodee，简写写cdee；naame简简写nmme；ddepaartmmentt简写 dptt；年月月简写pptyeear,ptmmnthh,金额额简写oorgaamt，ooccaamt,acccamtt；日期期简写 ptddatee,occcdaat,eeffddat,strrdatt,enndatte等。2、SStriing类类型必须须定义适适当的长长度；Douublee、Flloatt类型必必须定义义适当的的长度及及精度Collumnn(nuullaablee = truue,llen
7、ggth =100)，如果果是长文文档备注注类型，直直接定义义为LLob类类型Collumnn(nuullaablee = truue,ppreccisiion=14, sscalle=22)3、可可以为列列建唯一一索引，如如下所示示Collumnn(nuullaablee = truue,llenggth =155,unniquue=ttruee)coluumnDDefiinittionn,为列列设定默默认值4、按按适当的的情况定定义主键键及复合合索引等等Tabble(namme=syss_cllnt,unniquueCoonsttraiintss=UniiqueeConnstrrainnt
8、(ccoluumnNNamees=cllntiid,siimpnnamee)定义本BBeanns的主主键，主主键可以以是Inntegger,Strringg,Daate等等类型IdTabbleGGeneerattor(namme = SSId, ttablle = ssysiid, pkkCollumnnNamme = iid, vaalueeCollumnnNamme = ttablleidd, pkCColuumnVValuue = 55, alllocaatioonSiize = 11, iinittiallVallue = 11000000000)GenneraateddVallue(
9、strrateegy = GGeneerattionnTyppe.TTABLLE, genneraatorr = SIId)Coolummn(nnulllablle = faalsee,leengtth =10)privvatee Sttrinng uuserrcodde;5、每每个定段段必须要要用行注注释“/”的形式式来说明明字段的的意义，每每行注释释必须对对齐，说说明必须须清晰，如如果该字字段内容容来自于于SyssIteem，则则需在注注释中说说明ITTEMIID键值值等。6、在定定义中，我我们使用用的类型型仅为SStriing、Douublee、Inntegger、DDatee、Loon
10、g型型，不使使用其它它类型（在在保险相相关的项项目中，所所有的日日期型均均使用DDatee型,其其它类型型项目使使用Loong型型）。（三）JJSP或或HTMML页面面规范1、 下拉列表表需要使使用框起来。2、 标识为必必需录入框的的语句为*，该标识识放置于于录入框的的后面。3、 如何格式式化数字，4、 一般中文文或是字字符串要要求左对对齐；定长数据可可以居中中（如固固定长度度日期，固固定长度度订单号号，固定长长度身份证，定定长代码等），数数字要求求右对齐齐（后面面再放置置“&nnbspp; &nbssp;”占位），且必须格式化，如#,#0.00这种，单价/金额/发票/一般保留二位，重量与常规
11、的数量保留整数。5、 页面上所所有的录录入框、下下拉列表表等，必必须使用适适当的clssasss或SttyleeClaass类类型，控控件的长长度一般般一致，每每行三列列数据项的方式式排列。6、 Jsp或或是Httml文文件名首首字母必必须大写。7、 Jsp中中使用TTABLLE时，其中中的、要有缩进进及对齐。8、 对acttionn中返回回到Jssp的Lisst-objjs，除了能能直接使使用对象象的外，一律使用数组的方式实现输出，如下所示：$objjs00$oobjss1$oobjss2$oobjss39、jjsp/javva中不不得有任任何引起起警告的的代码。10、在在任何一一个JSPP
12、中，对JSPP的BODDY使用用如下样样式，支支持按回回车跳下一一个控件11、在在JSPP中，如如果以按按钮提交交的方式式来定义义提交对对应的类类型，通通用方法法强制用用以下方方法命名名保存：编辑：删除：查询：12、在在JSPP中，如如果以aactiiveTTypee的方式式来定义义提交类类型，通通用方法法强制用用以下代代码表示示：保存：编辑：删除：查询：13、对对于有CCODEE及NAAME形形式显示示的资料料，在页页面上一一律使用用CODDENNAMEE的形式式显示给给用户。14、查查询及报报表保证所有有查询条条件的有有效性；汇总及及明细一一致性，查查询结果果及报表表输出的的一致性性；不同
13、同查询或或是报表表的结果果一致性性，页面面常见功功能的有有效性。无论何种种情况，如如果报表表与查询询需求并非非一致，不不能放在在同一页页面中。任何报表表，必须须先有查查询及JJSP Lisst，才才能有打打印。报表的风风格要求求：按公公司报表表模板执执行。（四）JJAVAA编程规规范1、通用用命名规规范标识符类类型命名规则则示例Packkagees包名全部部使用小小写字母母。包名名类似如如下结构构：域.公司名名.项目目名.模模块名.功能名名.组件件名infoo.kuuke.liffe.pps.ccanccelllatiion.hessitaate.beaanClasssess类名要求求使用简简
14、单的，能能描述类类功能的的名词，避避免使用用缩写（通通用缩写写如URRL、HHTMLL除外）。标标记符中中所有单单词都应应紧靠在在一起，每每一单词词首字母母大写，其其余字母母小写。classs PPoliicyPProdducttSerrvleetActiion,Forrm,DDao出以上类类名规则则外，还还要在后后面加上上Forrm,DDao,Acttionn后缀Inteerfaacess命名规则则同cllasssesinteerfaace RennewCCharrgeDDAOMethhodss方法名使使用动词词，要求求能简单单描述方方法实现现的功能能。标记符中中所有单单词都应应紧靠在在一起
15、，第第一个单单词首字字母小写写，其它它单词首首字母大大写，其其余字母母小写。doPrroceess();getPPoliicyCCodee();Variiablles变量名要要求简单单并且有有含义。变量名中中所有单单词都应应紧靠在在一起，第第一个单单词首字字母小写写，其它它单词首首字母大大写，其其余字母母小写。在变量名名中避免免使用_和$符符号。一些通用用的临时时变量如如整型使使用i,j,kk，字符符型使用用c,dd,eint i;charr c;BigDDeciimall fuundPPricce;Consstannts常量名全全部使用用大写字字母并且且单词间间使用_分隔Statticffi
16、naal iint FEEE_TYYPE_R =44;2、acctioon & foorm中中的特殊殊命名要要求：a.AcctioonMaappiin命名名为maappiing；ActtionnForrm命名名为pFFormm；HtttpSeervlletRRequuestt命名为为reqq；HtttpSServvlettRessponnse命命名为rres；b.Acctioon中用用于拼装装SQLL条件的的StrringgBuffferr变量一一律命名名为hql或ssql，如如果需要要二个以以上，则则是hqql0/sqll0、hhql11/sqql1、hql2/sql23、所有有分页查询询的
17、acctioon一律律使用ggetLListt或gettLisstByySQLL这二个个函数完完成，如如果使用用这二个个函数，引引用方法法一律为为DAOO.geetLiist的形形式。a、特殊殊情况下下，使用用exeecutteSQQLQuueryy或exxecuuteQQuerry获取取数据，则则需在aactiion中中添加代代码if(ppForrm.ggetRRowssPerrPagge()!=00) pagee.seetRoowsPPerPPagee(pFFormm.geetRoowsPPerPPagee();4、对数数据库中中选出的的分页记记录中的的Lonng型日日期，在在acttio
18、nn中直接接转化为为页面需需要的”yyyyy-MMM-ddd”类型，不不建议使使用数据据库的函函数完成成转换，因因为不能能使用程程序通用用化，参参考以下下代码：SimppleDDateeForrmatt dff = neww SiimplleDaateFFormmat(yyyyy-MM-dd HH:mm:ss.SSSS); intt i=0; foor(IIterratoor iit = paage.gettLisst().itteraatorr();it.hassNexxt();) OObjeect ssi = (OObjeect)iit.nnextt(); si5=(sii5!=nnull
19、l?dff.foormaat(nnew Datte(LLongg.vaalueeOf(si5.toSStriing():); pagge.ggetLListt().sett(i, sii);i+;5、所有有的方法法必须有有方法注注释，详详见前面面的格式式；如果果程序超超过2000行左左右的代代码，应应该分为为不同的的方法或或是函数数，维护护程序的的可读性性。6、任何何JAVVA代码码中不能能有引起起警告状状态；对对不得不不使用而而导致的的情况按按以下方方法进行行处理。SupppreessWWarnninggs(deppreccatiion)SupppreessWWarnninggs(uncch
20、ecckedd )SupppreessWWarnninggs(deepreecattionn, unncheeckeed)7、常规规程序要要求：事事务提交交的一致致性及错错误回滚滚要求；程序功功能流转转保证正正确，相相关数据据准确无无误，含含各种验验证及错错误处理理，不能能有应用用服务器器的报告告错误页页面出现现8、代码码缩排规规则（1）同同行的代代码缩排排的间距距一般定定为4个个空格，TTab键键一般设设为4个个空格。（2）行行代码或或注释的的长度尽尽量少于于80个个字符，如如果一行行代码过过长，应应该换行行。（3）逗逗号后加加空格后后再写其其他代码码，在每每个运算算符前后后也都要要留有空空
21、格。（4）长长的语句句（880字符符）要分分成多行行书写，长长表达式式要在低低优先级级操作符符处划分分新行，操操作符放放在新行行之首，划划分出的的新行要要进行适适当的缩缩进，使使排版整整齐，语语句可读读。（5）表表达式在在换行时时应该首首先考虑虑在优先先级高的的运算符符处换行行，新行行的开始始位置应应该和原原先行的的相应字字符对齐齐。如：longgNamme1 = llonggNamme2 * (lonngNaame33 + lonngNaame44- loongNNamee5) + 44 * lonngnaame66; 应该该写成longgNamme1 = llonggNamme2 * (l
22、onngNaame33 + lonngNaame44 - lonngNaame55)+ 4 * llonggnamme6;例如SQQL拼装装式例，每每个字段段分一行行，”,”放在字字段的前前面，如如下所示示。sql.apppendd(sseleect orggcodde +,orrgannizeenamme +,pttyeaar +,pttmntth, +,abb);（6）对对独立的的程序块块之间、变变量说明明之后必必须加空空行。（7）函函数或过过程中的的参数较较长，则则要进行行适当的的划分。（8）不不允许把把多个短短语句写写在一行行中，即即一行只只能写一一条语句句。（9）iif、forr、do、whiile、casse、swiitchh、deffaullt等语语句自占占一行，且且if、forr、do、whiile等等语句的的执行语语句部分分无论多多少都要要加括号号。（10）对对齐只使使用TAAB，不不使用空空格键。页码： 9 / 9 保密要求：机密函件