【正文】 Java編碼規(guī)范Document number 文檔編號(hào) Confidentiality level 密級(jí) 內(nèi)部公開(kāi)Document version 文檔版本 Total 28 pages 共 28 頁(yè)Java語(yǔ)言編碼規(guī)范Prepared by 擬制Date日期yyyymmddReviewed by 評(píng)審人Date日期yyyymmddApproved by批準(zhǔn)Date日期yyyymmddRevision Record 修訂記錄Date日期Revision Version修訂版本Sec No. 修改章節(jié)Change Description修改描述Author作者yyyymmddTable of Contents 目錄1. 范圍 42. 規(guī)范性引用文件 43. 術(shù)語(yǔ)和定義 44. 排版規(guī)范 5. 規(guī)則 5. 建議 75. 注釋規(guī)范 8. 規(guī)則 8. 建議 136. 命名規(guī)范 16. 規(guī)則 16. 建議 177. 編碼規(guī)范 19. 規(guī)則 19. 建議 238. JTEST規(guī)范 25. 規(guī)則 25. 建議 26 1. 范圍本規(guī)范規(guī)定了使用Java語(yǔ)言編程時(shí)排版、注釋、命名、編碼和JTEST的規(guī)則和建議。本規(guī)范適用于使用Java語(yǔ)言編程的產(chǎn)品和項(xiàng)目。2. 規(guī)范性引用文件下列文件中的條款通過(guò)本規(guī)范的引用而成為本規(guī)范的條款。凡是注日期的引用文件，其隨后所有的修改單（不包括勘誤的內(nèi)容）或修訂版均不適用于本規(guī)范，然而，鼓勵(lì)根據(jù)本規(guī)范達(dá)成協(xié)議的各方研究是否可使用這些文件的最新版本。凡是不注日期的引用文件，其最新版本適用于本規(guī)范。序號(hào)編號(hào)名稱(chēng)1公司 《Java語(yǔ)言編程規(guī)范》3. 術(shù)語(yǔ)和定義規(guī)則：編程時(shí)強(qiáng)制必須遵守的原則。建議：編程時(shí)必須加以考慮的原則。格式：對(duì)此規(guī)范格式的說(shuō)明。說(shuō)明：對(duì)此規(guī)范或建議進(jìn)行必要的解釋。示例：對(duì)此規(guī)范或建議從正、反兩個(gè)方面給出例子。4. 排版規(guī)范. 規(guī)則. *程序塊要采用縮進(jìn)風(fēng)格編寫(xiě)，縮進(jìn)的空格數(shù)為4個(gè)。說(shuō)明：對(duì)于由開(kāi)發(fā)工具自動(dòng)生成的代碼可以有不一致。. *分界符（如大括號(hào)‘{’和‘}’）應(yīng)各獨(dú)占一行并且位于同一列，同時(shí)與引用它們的語(yǔ)句左對(duì)齊。在函數(shù)體的開(kāi)始、類(lèi)和接口的定義、以及if、for、do、while、switch、case語(yǔ)句中的程序都要采用如上的縮進(jìn)方式。示例：如下例子不符合規(guī)范。for (...) { ... // program code}if (...) { ... // program code } void example_fun( void ) { ... // program code }應(yīng)如下書(shū)寫(xiě)：for (...) { ... // program code}if (...) { ... // program code} void example_fun( void ){ ... // program code} . *較長(zhǎng)的語(yǔ)句、表達(dá)式或參數(shù)（80字符）要分成多行書(shū)寫(xiě)，長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放在新行之首，劃分出的新行要進(jìn)行適當(dāng)?shù)目s進(jìn)，使排版整齊，語(yǔ)句可讀。 示例：if (filename != null amp。amp。 new File(logPath + filename).length() ()){ ... // program code} public static LogIterator read(String logType, Date startTime, Date endTime, int logLevel, String userName, int bufferNum) . *不允許把多個(gè)短語(yǔ)句寫(xiě)在一行中，即一行只寫(xiě)一條語(yǔ)句示例：如下例子不符合規(guī)范。LogFilename now = null。 LogFilename that = null。應(yīng)如下書(shū)寫(xiě)：LogFilename now = null。LogFilename that = null。 . *if, for, do, while, case, switch, default 等語(yǔ)句自占一行，且if, for, do, while等語(yǔ)句的執(zhí)行語(yǔ)句無(wú)論多少都要加括號(hào){}。示例：如下例子不符合規(guī)范。if(writeToFile) ()。 應(yīng)如下書(shū)寫(xiě)：if(writeToFile){()。} . *相對(duì)獨(dú)立的程序塊之間、變量說(shuō)明之后必須加空行。示例：如下例子不符合規(guī)范。if(() ()){ return。}LogWriter writer。 應(yīng)如下書(shū)寫(xiě)：if(() ()){return。}LogWriter writer。int index。 . *對(duì)齊只使用空格鍵，不使用TAB鍵。說(shuō)明：以免用不同的編輯器閱讀程序時(shí)，因TAB鍵所設(shè)置的空格數(shù)目不同而造成程序布局不整齊。JBuilder、UltraEdit等編輯環(huán)境，支持行首TAB替換成空格，應(yīng)將該選項(xiàng)打開(kāi)。. *在兩個(gè)以上的關(guān)鍵字、變量、常量進(jìn)行對(duì)等操作時(shí)，它們之間的操作符之前、之后或者前后要加空格；進(jìn)行非對(duì)等操作時(shí)，如果是關(guān)系密切的立即操作符（如.），后不應(yīng)加空格。說(shuō)明：采用這種松散方式編寫(xiě)代碼的目的是使代碼更加清晰。由于留空格所產(chǎn)生的清晰性是相對(duì)的，所以，在已經(jīng)非常清晰的語(yǔ)句中沒(méi)有必要再留空格，如果語(yǔ)句已足夠清晰則括號(hào)內(nèi)側(cè)(即左括號(hào)后面和右括號(hào)前面)不需要加空格，多重括號(hào)間不必加空格，因?yàn)樵贘ava語(yǔ)言中括號(hào)已經(jīng)是最清晰的標(biāo)志了。在長(zhǎng)語(yǔ)句中，如果需要加的空格非常多，那么應(yīng)該保持整體清晰，而在局部不加空格。給操作符留空格時(shí)不要連續(xù)留兩個(gè)以上空格。示例：（1） 逗號(hào)、分號(hào)只在后面加空格。int a, b, c。 （2） 比較操作符, 賦值操作符=、 +=，算術(shù)操作符+、%，邏輯操作符amp。amp。、amp。，位域操作符、^等雙目操作符的前后加空格。if (current_time = MAX_TIME_VALUE) a = b + c。a *= 2。a = b ^ 2。 （3） !、~、++、amp。（地址運(yùn)算符）等單目操作符前后不加空格。flag = !isEmpty。 // 非操作!與內(nèi)容之間i++。 // ++,與內(nèi)容之間 （4） .前后不加空格。 = pid。 // .前后不加空格 （5） if、for、while、switch等與后面的括號(hào)間應(yīng)加空格，使if等關(guān)鍵字更為突出、明顯。if (a = b amp。amp。 c d). 建議類(lèi)屬性和類(lèi)方法不要交叉放置，不同存取范圍的屬性或者方法也盡量不要交叉放置。格式：類(lèi)定義{類(lèi)的公有屬性定義類(lèi)的保護(hù)屬性定義類(lèi)的私有屬性定義類(lèi)的公有方法定義類(lèi)的保護(hù)方法定義類(lèi)的私有方法定義}5. 注釋規(guī)范. 規(guī)則. 一般情況下，源程序有效注釋量必須在30％以上。說(shuō)明：注釋的原則是有助于對(duì)程序的閱讀理解，在該加的地方都加了，注釋不宜太多也不能太少，注釋語(yǔ)言必須準(zhǔn)確、易懂、簡(jiǎn)潔?？梢杂米⑨尳y(tǒng)計(jì)工具來(lái)統(tǒng)計(jì)。. 包的注釋?zhuān)喊淖⑨寣?xiě)入一名為 的HTML格式說(shuō)明文件放入當(dāng)前路徑。說(shuō)明：方便JavaDoc收集示例：/huawei/msg/relay/m/. 包的注釋內(nèi)容：簡(jiǎn)述本包的作用、詳細(xì)描述本包的內(nèi)容、產(chǎn)品模塊名稱(chēng)和版本、公司版權(quán)。說(shuō)明：在詳細(xì)描述中應(yīng)該說(shuō)明這個(gè)包的作用以及在整個(gè)項(xiàng)目中的位置。格式：htmlbodyp一句話(huà)簡(jiǎn)述。p詳細(xì)描述。p產(chǎn)品模塊名稱(chēng)和版本br公司版權(quán)信息/body/html 示例：htm