ERP程序撰寫規(guī)范

1、ERP程序撰寫規(guī)范2009-01-21將開(kāi)發(fā)人人員的編編程風(fēng)格格在制度度上統(tǒng)一一，有助助于團(tuán)隊(duì)隊(duì)的協(xié)同同工作，避免因?yàn)闉榫幋a風(fēng)風(fēng)格不同同產(chǎn)生的的問(wèn)題。前言擺放目錄錄sysIdconfigcompIdsysIdhtmljspsrcworkxmldrcompIdsysIdcomicscsysiddaofuncuitagdxConfig目錄下擺擺放*.ini文件和*.xml文件。其中xml文件的命命名是系系統(tǒng)別+Structs，例如：mpvStructs.xml,mpv是系統(tǒng)別別。Jsp目錄下存存放jsp文件jsp文件的命命名：系系統(tǒng)別+jj+序號(hào)，每每個(gè)jsp頁(yè)面必須須有一個(gè)個(gè)pageId,pag

2、eId對(duì)應(yīng)jsp頁(yè)面的名名稱，可可大小寫寫混用，例如xxjj001.jsp,pageId為xxjj001注：如果果為三位位的系統(tǒng)統(tǒng)別，jsp文件命名名為系統(tǒng)統(tǒng)別+j+序號(hào)。Jsp頁(yè)面編碼碼規(guī)范1.Jsp在開(kāi)始處處加上注注釋，描描述相關(guān)關(guān)信息。2.Jsp頁(yè)面開(kāi)始始首行，必須是是這行代代碼3.Jsp頁(yè)面代碼碼開(kāi)始次次行，必必須是這這行代碼碼4.所有的declare 必須寫在在JSP頁(yè)面最前前面，其其次為scriplet的語(yǔ)句。JavaScript語(yǔ)句放到到頁(yè)面最最下方（對(duì)于include的jss文件如果果寫在jsp下方有問(wèn)問(wèn)題那么么請(qǐng)?jiān)诎窗凑粘绦蛐蛐枰椒绞綌[放放）。5.每個(gè)標(biāo)簽簽必須突突出彼此此

3、間的層層次感，一律以以換行空空4格的方式式。例如如：.6Script的include方式為以以下樣式式。scriptsrc=7Script區(qū)中方法法的定義義層次清清晰，每每層之間間空四格格，8其它編編碼規(guī)范范請(qǐng)配合合加強(qiáng)版版Struts架構(gòu)中Jsptaglib要求的寫寫法。9jsp中變量定定義統(tǒng)一一定義在在頁(yè)面最最上方j(luò)sp語(yǔ)句開(kāi)始始前。系統(tǒng)Java文件Src目錄擺放放結(jié)構(gòu).icsc.系統(tǒng)別.dao :該目錄下下擺放所所有該系系統(tǒng)的dao和vo。VO（ValueObject）DAO（Data AccessObject）命名方式式為mejc01VO和mejc01DAO.icsc.系統(tǒng)別.func

4、:該目錄下下擺放所所有該系系統(tǒng)的業(yè)業(yè)務(wù)邏輯輯。業(yè)務(wù)邏輯輯命名方方式：pageId(將第二個(gè)個(gè)j改為c)+”Func”.如某pageId為xxjj001,那么對(duì)應(yīng)應(yīng)的邏輯輯為xxjc001F.icsc.系統(tǒng)別.ui:該目錄下下擺放所所有該系系統(tǒng)對(duì)頁(yè)頁(yè)面的控控制邏輯輯。Ui的命名與與業(yè)務(wù)邏邏輯命名名相對(duì)應(yīng)應(yīng)，如果果Func為xxjc001Func.java，則ui一般為xxjc001UI.icsc.系統(tǒng)別.tag :該目錄下下擺放所所有該系系統(tǒng)對(duì)頁(yè)頁(yè)面的用用戶自定定義tag取值的邏邏輯。對(duì)應(yīng)的class是com.icsc.dpms.du.tag.dujcSelectcompId.javacom.i

5、csc.dpms.du.tag.dujcRemoteFirDeptFinder.javaxml下存放Pdf報(bào)表文件件的xml檔Work下存放Excel報(bào)表文件件命名原則則packagesPackage命名規(guī)則則以系統(tǒng)統(tǒng)為單位位，另因因DPMS系統(tǒng)為共共享模塊塊所以將將統(tǒng)一命命名，至至于應(yīng)用用系統(tǒng)里里同一業(yè)業(yè)務(wù)但因因個(gè)別公公司商業(yè)業(yè)處理邏邏輯不同同需由共共同程序序分離時(shí)時(shí)，其程程序命名名規(guī)則為為在原程程序后多多加一位位，而Package命名則相相同。Package命名規(guī)則則如下：com.icsc.XX.*系統(tǒng)代號(hào)號(hào)例子：com.icsc.aacom.icsc.dpms.ducom.icsc.mp

6、.mpvClasses AndInterfaces程序(亦即Class)命名標(biāo)準(zhǔn)準(zhǔn):8碼(全小寫)XXXXXXXX流水序號(hào)號(hào)程序類別別系統(tǒng)細(xì)項(xiàng)項(xiàng)功能系統(tǒng)代號(hào)號(hào)程序類別別：A-APPLETB-BEANC-CLASSE-EJBH-HTMLI-InterfaceJ-JSPS-SERVLETT-SCRIPTX-ExceptiZ-CSS例如：aajj01.jsp，aaje01.java，dejtmf.jss，dswhelp.html，dzwcss.guiMethod 必須以動(dòng)動(dòng)詞為起起頭，由由24字所組成成,其動(dòng)詞第第一個(gè)英英文字母母需為小小寫，下下一個(gè)字字，其第第一個(gè)英英文字母母需為大大寫，字字與字之

7、之間不以以特殊符符號(hào)分隔隔例如：run();runFast();getBackground();方法參數(shù)數(shù)的命名名方式請(qǐng)請(qǐng)按照一一定的邏邏輯順序序，比如如按照key優(yōu)先順序序擺放。Variables變量命名名需簡(jiǎn)短短但具有有意義，由13字所組成成,其第一個(gè)個(gè)字的第第一個(gè)英英文字母母需為小小寫，且且不得為為特殊符符號(hào)，接接續(xù)的字字，其第第一個(gè)英英文字母母需為大大寫，字字與字之之間不以以特殊符符號(hào)分隔隔。最好好避免以以單一字字母命名名，除非非該變量量為暫存存用途，通常這這些變量量命名規(guī)規(guī)則為i,j,k,m,n為integer；c,d,e為charDAO變量命名名方式：表名+”DAO”;VO變量命名

8、名方式：表名+”VO”;如表名為為db.tbme01,那么對(duì)應(yīng)應(yīng)DAO變量名稱稱命名為為me01DAO,VO變量名稱稱命名為為me01VO;多筆資料料的變量量定義為為me01ListConstants常量命名名需簡(jiǎn)短短但具有有意義，由13字所組成成,所有字母母皆為大大寫，字字與字之之間以u(píng)nderline(_)連接例如：staticfinalintMIN_WIDTH=4;staticfinalintMAX_WIDTH=99;Databases原則上一一個(gè)公司司一個(gè)Database，全部以以大寫字字母，命命名規(guī)則則如下：IDBXXXXX公司簡(jiǎn)稱稱DB:代表Database中冠代號(hào)號(hào)例如：idbb

9、xTables全部以大大寫字母母，命名名規(guī)則如如下：TBXXXX流水序號(hào)號(hào)系統(tǒng)代號(hào)號(hào)TB:代表Table例如：tbdsmfColumns 字段命名名需簡(jiǎn)短短但具有有意義，由13字所組成成,其每個(gè)字字皆為大大寫，且且不得為為特殊符符號(hào)，字字與字之之間不以以特殊符符號(hào)分隔隔。例如：userName,deptNameStoreProcedure全部以大大寫字母母，命名名規(guī)則如如下：SPXXXX流水序號(hào)號(hào)系統(tǒng)代號(hào)號(hào)SP:代表Storeprocedure例如：SPAA01程序代碼碼要求1.必須有注注釋2.每個(gè)方法法的行數(shù)數(shù)一般不不得超過(guò)過(guò)50行，請(qǐng)將將方法中中的語(yǔ)句句盡可能能的重構(gòu)構(gòu)，實(shí)現(xiàn)現(xiàn)邏輯的的封裝，降低耦耦合性。每行語(yǔ)句句不得超超過(guò)120個(gè)字符，如果有有超過(guò)，請(qǐng)短行行在標(biāo)點(diǎn)點(diǎn)符號(hào)后后面。短短行后的的語(yǔ)句請(qǐng)請(qǐng)比上一