Java軟件開(kāi)發(fā)代碼規(guī)范.doc

《Java軟件開(kāi)發(fā)代碼規(guī)范.doc》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在應(yīng)用文檔-天天文庫(kù)。

1、Java軟件開(kāi)發(fā)代碼規(guī)范俗話說(shuō)無(wú)規(guī)矩不成方圓，在現(xiàn)實(shí)生活中，不管我們做什么事都講究規(guī)則，軟件開(kāi)發(fā)也一樣，無(wú)論你在什么樣的軟件開(kāi)發(fā)公司，無(wú)論你從事安卓軟件開(kāi)發(fā)還是手機(jī)軟件開(kāi)發(fā)，都必須要遵循軟公司的規(guī)則，軟件開(kāi)發(fā)的規(guī)則，行業(yè)的規(guī)則；我們只有遵循這些規(guī)則，有一個(gè)好的軟件開(kāi)發(fā)流程，才能一直很好的走下去，才能有進(jìn)步，下面我和大家共同探討一下軟件開(kāi)發(fā)的規(guī)則，也就是說(shuō)我們開(kāi)發(fā)一個(gè)軟件需要滿(mǎn)足哪些要求；有不中之處還望大家多多指點(diǎn)：(由于本人重點(diǎn)從事Java軟件開(kāi)發(fā)，所以重點(diǎn)說(shuō)的是Java軟件開(kāi)發(fā)的規(guī)則，大同小異了)1、代碼組織與風(fēng)格(1).關(guān)鍵詞和操作符之間加適當(dāng)?shù)目崭瘛?/p>

2、(2).相對(duì)獨(dú)立的程序塊與塊之間加空行(3).較長(zhǎng)的語(yǔ)句、表達(dá)式等要分成多行書(shū)寫(xiě)。(4).劃分出的新行要進(jìn)行適應(yīng)的縮進(jìn)，使排版整齊，語(yǔ)句可讀。(5).長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放在新行之首。(6).循環(huán)、判斷等語(yǔ)句中若有較長(zhǎng)的表達(dá)式或語(yǔ)句，則要進(jìn)行適應(yīng)的劃分。(7).若函數(shù)或過(guò)程中的參數(shù)較長(zhǎng)，則要進(jìn)行適當(dāng)?shù)膭澐帧?8).不允許把多個(gè)短語(yǔ)句寫(xiě)在一行中，即一行只寫(xiě)一條語(yǔ)句。(9).函數(shù)或過(guò)程的開(kāi)始、結(jié)構(gòu)的定義及循環(huán)、判斷等語(yǔ)句中的代碼都要采用縮進(jìn)風(fēng)格。2、軟件開(kāi)發(fā)中的注解定義這個(gè)規(guī)范的目的是讓項(xiàng)目中所有的文檔都看起來(lái)像一個(gè)人寫(xiě)的，增加可讀性，

3、減少項(xiàng)目組中因?yàn)閾Q人而帶來(lái)的損失。（這些規(guī)范并不是一定要絕對(duì)遵守，但是一定要讓程序有良好的可讀性）。Java的語(yǔ)法與C++及為相似，那么，你知道Java的注釋有幾種嗎？是兩種？//注釋一行/*......*/注釋若干行不完全對(duì)，除了以上兩種之外，還有第三種，文檔注釋?zhuān)?**......*/注釋若干行，并寫(xiě)入javadoc文檔注釋要簡(jiǎn)單明了。StringuserName=null;//用戶(hù)名邊寫(xiě)代碼邊注釋?zhuān)薷拇a同時(shí)修改相應(yīng)的注釋?zhuān)员ＷC注釋與代碼的一致性。?在必要的地方注釋?zhuān)⑨屃恳m中。注釋的內(nèi)容要清楚、明了，含義準(zhǔn)確，防止注釋二義性。保持注釋與其描述

4、的代碼相鄰，即注釋的就近原則。?對(duì)代碼的注釋?xiě)?yīng)放在其上方相鄰位置，不可放在下面。對(duì)數(shù)據(jù)結(jié)構(gòu)的注釋?xiě)?yīng)放在其上方相鄰位置，不可放在下面；對(duì)結(jié)構(gòu)中的每個(gè)域的注釋?xiě)?yīng)放在此域的右方；同一結(jié)構(gòu)中不同域的注釋要對(duì)齊。變量、常量的注釋?xiě)?yīng)放在其上方相鄰位置或右方。全局變量要有較詳細(xì)的注釋?zhuān)▽?duì)其功能、取值范圍、哪些函數(shù)或過(guò)程存取它以及存取時(shí)注意事項(xiàng)等的說(shuō)明。在每個(gè)源文件的頭部要有必要的注釋信息，包括：文件名；版本號(hào)；作者；生成日期；模塊功能描述（如功能、主要算法、內(nèi)部各部分之間的關(guān)系、該文件與其它文件關(guān)系等）；主要函數(shù)或過(guò)程清單及本文件歷史修改記錄等。/**?*CopyR

5、ightInformation:NeusoftIIT?*Project:eTrain?*JDKversionused:jdk1.3.1?*Comments:configpath?*Version:1.01?*Modificationhistory:2003.5.1?*SrDateModifiedByWhy&Whatismodified?*1.2003.5.2KevinGaonew?**/在每個(gè)函數(shù)或過(guò)程的前面要有必要的注釋信息，包括：函數(shù)或過(guò)程名稱(chēng)；功能描述；輸入、輸出及返回值說(shuō)明；調(diào)用關(guān)系及被調(diào)用關(guān)系說(shuō)明等/**?*Description:checkou

6、t提款?*@paramHashtablecartinfo?*@paramOrderBeanorderinfo?*@returnString?*/????publicStringcheckout(HashtablehtCart,????OrderBeanorderBean)????throwsException{?}javadoc注釋標(biāo)簽語(yǔ)法@author對(duì)類(lèi)的說(shuō)明標(biāo)明開(kāi)發(fā)該類(lèi)模塊的作者@version對(duì)類(lèi)的說(shuō)明標(biāo)明該類(lèi)模塊的版本@see對(duì)類(lèi)、屬性、方法的說(shuō)明參考轉(zhuǎn)向，也就是相關(guān)主題@param對(duì)方法的說(shuō)明對(duì)方法中某參數(shù)的說(shuō)明@return對(duì)方法的說(shuō)明對(duì)方法

7、返回值的說(shuō)明@exception對(duì)方法的說(shuō)明對(duì)方法可能拋出的異常進(jìn)行說(shuō)明3、軟件開(kāi)發(fā)中的命名規(guī)范定義這個(gè)規(guī)范的目的是讓項(xiàng)目中所有的文檔都看起來(lái)像一個(gè)人寫(xiě)的，增加可讀性，減少項(xiàng)目組中因?yàn)閾Q人而帶來(lái)的損失。（這些規(guī)范并不是一定要絕對(duì)遵守，但是一定要讓程序有良好的可讀性）較短的單詞可通過(guò)去掉"元音"形成縮寫(xiě)；要不然最后自己寫(xiě)的代碼自己都看不懂了，那可不行。較長(zhǎng)的單詞可取單詞的頭幾發(fā)符的優(yōu)先級(jí)，并用括號(hào)明確表達(dá)式的操作順序，避免使用默認(rèn)優(yōu)先級(jí)。使用匈牙利表示法Package的命名?Package的名字應(yīng)該都是由一個(gè)小寫(xiě)單詞組成。packagecom.neu.uti

8、l?Class的命名Class的名字必須由大寫(xiě)字母開(kāi)頭而其他字母都