java編碼規(guī)范

java編碼規(guī)范

ID:20827177

大?。?01.00 KB

頁(yè)數(shù):60頁(yè)

時(shí)間:2018-10-15

java編碼規(guī)范_第1頁(yè)
java編碼規(guī)范_第2頁(yè)
java編碼規(guī)范_第3頁(yè)
java編碼規(guī)范_第4頁(yè)
java編碼規(guī)范_第5頁(yè)
資源描述:

《java編碼規(guī)范》由會(huì)員上傳分享,免費(fèi)在線閱讀,更多相關(guān)內(nèi)容在教育資源-天天文庫(kù)。

1、一、JAVA編碼規(guī)范編碼規(guī)范概述文件體系結(jié)構(gòu)規(guī)則文件命名規(guī)則排版規(guī)則注釋規(guī)則命名規(guī)則變量方法可讀性程序效率質(zhì)量保證1.編碼規(guī)范概述制定編碼規(guī)范的最主要的目的是為了對(duì)產(chǎn)出代碼的長(zhǎng)期維護(hù)。通常負(fù)責(zé)維護(hù)代碼的人大多都不是開發(fā)者本人,如果有一個(gè)統(tǒng)一的代碼格式以及說(shuō)明就可以減少混淆提高理解速度。范圍編碼規(guī)范定義了所有代碼編寫者在編寫Java代碼時(shí)應(yīng)遵守的一些規(guī)則和習(xí)慣。本規(guī)范采用以下術(shù)語(yǔ)描述:規(guī)則:編程時(shí)強(qiáng)制必須遵守的原則。建議:編程時(shí)必須加以考慮的原則。示例:對(duì)此規(guī)則或建議給出例子。2.文件體系結(jié)構(gòu)規(guī)則2.1文件體系

2、規(guī)則規(guī)則2.1.1JSP文件目錄結(jié)構(gòu)

3、――cgi存放cgi程序

4、――cgi-bin存放cgi編譯后的程序

5、――css存放樣式表

6、――html存放臨時(shí)生成的報(bào)表文件

7、――images存放圖片

8、――include存放系統(tǒng)要引用的文件

9、――js存放javascript腳本

10、――ocx存放ocx控件

11、――page存放JSP頁(yè)面

12、――模塊分類名

13、――WEB-INFWEB配置文件,class文件2.文件體系結(jié)構(gòu)規(guī)則2.1文件體系規(guī)則建議2.1.2Java文件目錄結(jié)構(gòu)

14、――<模塊分類目錄>模塊分類

15、――action存放ac

16、tion(控制層)文件

17、――dao存放dao(數(shù)據(jù)層)文件

18、――form存放form(展示層)文件

19、――service存放業(yè)務(wù)邏輯文件

20、――vo存放數(shù)據(jù)對(duì)象文件2.文件體系結(jié)構(gòu)規(guī)則2.2源文件結(jié)構(gòu)規(guī)則規(guī)則2.2.1包和引入語(yǔ)句先寫包語(yǔ)句,再寫引入語(yǔ)句。package行和import行之間留一行空行。引入的標(biāo)準(zhǔn)包名要在本地包名之前,并且包名按照字母順序排列。如果import行中包含了同一個(gè)包中的類超過(guò)5個(gè),則用*來(lái)處理。import的標(biāo)準(zhǔn)包和本地包之間留一行空行。示例:packagecom.sitech.crm

21、pd.core.codegen;importjava.sql.DatabaseMetaData;importjava.sql.ResultSet;importcom.sitech.crmpd.core.config.Config;importcom.sitech.crmpd.core.jdbc.ConnectionFactory;2.文件體系結(jié)構(gòu)規(guī)則2.2源文件結(jié)構(gòu)規(guī)則規(guī)則2.2.2類/接口先寫類/接口注釋,標(biāo)明類/接口的用途、版本、作者等信息。類/接口注釋之后空一行,然后寫類/接口聲明。extends和im

22、plements寫在不同行。異常也單寫一行。示例:publicclassCounterSetextendsObservableimplementsCloneablethrowsXXXXXX2.文件體系結(jié)構(gòu)規(guī)則2.2源文件結(jié)構(gòu)規(guī)則規(guī)則2.2.3類變量的聲明順序是public,protected,package,private公共變量(Public)保護(hù)變量(Protected)包一級(jí)別的變量(沒(méi)有訪問(wèn)修飾符)私有變量(Private)2.文件體系結(jié)構(gòu)規(guī)則2.2源文件結(jié)構(gòu)規(guī)則規(guī)則2.2.4變量、常量的注釋應(yīng)放在其

23、上方相鄰位置或右方規(guī)則2.2.5用遞增的方式寫構(gòu)造器(比如:參數(shù)多的寫在后面)規(guī)則2.2.6類變量的存取方法:get和set方法規(guī)則2.2.7如果定義main()方法,必須將main方法寫在類的底部3.文件命名規(guī)則3.1Struts配制文件命名sc-模塊名.xml3.2jsp文件命名模塊名_main.jsp主文件模塊名_xxx.jspxxx命名詳見(jiàn)附錄A:詞典規(guī)范sxxxx文件夾,xxxx為opcodefxxxx_x.jspxxxxopcode,x序號(hào)3.3jsp文件命名模塊名Action.javaactio

24、n文件模塊名Form.javaform文件模塊名Svc.javaservice文件表名Dao.javadao文件表名Vo.javavo文件表名PK.java主鍵的vo文件4.排版規(guī)則4.1方法排版規(guī)則規(guī)則4.1.1方法名和其后的括弧之間不應(yīng)有空格示例:intgetResult(intforInt,charforChar)規(guī)則4.1.2縮進(jìn)采用4個(gè)空格注意:一定要使用空格鍵。這樣可以避免使用不同的編輯器閱讀程序時(shí),因TAB鍵所設(shè)置的空格數(shù)目不同而造成程序布局不整齊。4.排版規(guī)則4.1方法排版規(guī)則規(guī)則4.1.3在

25、方法的局部變量聲明和語(yǔ)句之間加一個(gè)空行示例:voidmethod1(){//聲明intanInt=0;StringaString=null;ObjectanObj=null;//語(yǔ)句if(condition){…}…}4.排版規(guī)則4.1方法排版規(guī)則規(guī)則4.1.4塊注釋或單行注釋之前必須有一行空行規(guī)則4.1.5方法內(nèi)的兩個(gè)邏輯段之間必須有一行空行建議4.1.6在方法的每個(gè)參數(shù)之間的逗號(hào)后面加一個(gè)空格4

當(dāng)前文檔最多預(yù)覽五頁(yè),下載文檔查看全文

此文檔下載收益歸作者所有

當(dāng)前文檔最多預(yù)覽五頁(yè),下載文檔查看全文
溫馨提示:
1. 部分包含數(shù)學(xué)公式或PPT動(dòng)畫的文件,查看預(yù)覽時(shí)可能會(huì)顯示錯(cuò)亂或異常,文件下載后無(wú)此問(wèn)題,請(qǐng)放心下載。
2. 本文檔由用戶上傳,版權(quán)歸屬用戶,天天文庫(kù)負(fù)責(zé)整理代發(fā)布。如果您對(duì)本文檔版權(quán)有爭(zhēng)議請(qǐng)及時(shí)聯(lián)系客服。
3. 下載前請(qǐng)仔細(xì)閱讀文檔內(nèi)容,確認(rèn)文檔內(nèi)容符合您的需求后進(jìn)行下載,若出現(xiàn)內(nèi)容與標(biāo)題不符可向本站投訴處理。
4. 下載文檔時(shí)可能由于網(wǎng)絡(luò)波動(dòng)等原因無(wú)法下載或下載錯(cuò)誤,付費(fèi)完成后未能成功下載的用戶請(qǐng)聯(lián)系客服處理。