程序編碼規(guī)范(java)

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

1、.程序編碼規(guī)范V1.0編寫(xiě)：×××審核：×××××××年××月修改....目錄一、引言3二、命名規(guī)范32.1包（Package）的命名32.2Class的命名42.3Class變量的命名42.4接口的命名52.5參數(shù)的命名52.6數(shù)組的命名52.6方法的參數(shù)6三注釋規(guī)范63.1塊注釋(BlockComments)73.2單行注釋(Single-LineComments)73.3尾端注釋(TrailingComments)73.4行末注釋(End-Of-LineComments)8四Java文件樣式84.1版權(quán)信息84.2Package/Imports94.3Class94.4Clas

2、sFields104.5存取方法104.6構(gòu)造函數(shù)104.7main方法114.8換行(WrappingLines)114.9行長(zhǎng)度(LineLength)134.10語(yǔ)句(Statements)13五排版格式18六JSP編碼規(guī)范19七、文件與目錄20八、日志規(guī)范20九、設(shè)計(jì)及技巧建議219.1表現(xiàn)層229.2業(yè)務(wù)層229.3持久層22....一、引言編碼規(guī)范對(duì)于程序員而言尤為重要，有以下幾個(gè)原因：1、一個(gè)軟件的生命周期中，80%的花費(fèi)在于維護(hù)。2、幾乎沒(méi)有任何一個(gè)軟件，在其整個(gè)生命周期中，均由最初的開(kāi)發(fā)人員來(lái)維護(hù)。3、編碼規(guī)范可以改善軟件的可讀性，可以讓程序員盡快而徹底地理解新的代

3、碼。4、如果你將源碼作為產(chǎn)品發(fā)布，就需要確任它是否被很好的打包并且清晰無(wú)誤，一如已構(gòu)建的其它任何產(chǎn)品為了執(zhí)行規(guī)范，每個(gè)軟件開(kāi)發(fā)人員必須一致遵守編碼規(guī)范中的代碼規(guī)范，代碼規(guī)范提高軟件代碼的可讀性,使得開(kāi)發(fā)人員快速和徹底的理解新代碼.。好的代碼風(fēng)格不僅會(huì)提高可讀性，而且會(huì)使代碼更健壯，更為重要的是在修改時(shí)不容易出錯(cuò)?，F(xiàn)代軟件開(kāi)發(fā)中，維護(hù)工作會(huì)占用80%的時(shí)間，而且開(kāi)發(fā)者和維護(hù)者通常不是同一個(gè)程序員。這意味著程序員經(jīng)常要閱讀和修改別人開(kāi)發(fā)的程序，別人也同樣可能需要閱讀和修改你開(kāi)發(fā)的程序，所以制定一套完善的編碼規(guī)范非常重要。定義本規(guī)范的目的是使項(xiàng)目中所有的文檔及程序編碼在寫(xiě)作風(fēng)格上具有一致性

4、，增加可讀性，減少項(xiàng)目組中因?yàn)閾Q人帶來(lái)的損失，從而使程序具有良好的可讀性。二、命名規(guī)范2.1包（Package）的命名包(Packages)：一個(gè)唯一包名的前綴應(yīng)全部為小寫(xiě)的ASCII字母，并且是一個(gè)頂級(jí)域名，通常為com、edu、gov、mil、net、org等。包名的后續(xù)部分可根據(jù)各個(gè)不同機(jī)構(gòu)內(nèi)部的命名規(guī)范來(lái)定義，這類(lèi)命名規(guī)范可以由特定的目錄名來(lái)區(qū)分部門(mén)(department)、項(xiàng)目(project)、機(jī)器(machine)和注冊(cè)名(loginnames)。l核心程序部分：com.xxxxxx.basel系統(tǒng)管理部分：com.xxxxxx.sys....l應(yīng)用維護(hù)部分：com.x

5、xxxxx.appconfigl項(xiàng)目計(jì)劃管理部分：com.xxxxxx.itemplanl采購(gòu)管理部分：com.xxxxxx.purchasel財(cái)務(wù)管理部分：com.xxxxxx.financel監(jiān)測(cè)評(píng)價(jià)部分：com.xxxxxx.analyse如果在開(kāi)發(fā)過(guò)程中還有其他情況沒(méi)有涵蓋到，可以按照上述規(guī)則進(jìn)行擴(kuò)展。2.2Class的命名Class的名字必須由一個(gè)大寫(xiě)字母開(kāi)頭其他字母為小寫(xiě)的單詞構(gòu)成。類(lèi)名要用完整的單詞，避免使用縮寫(xiě)詞(除非該縮寫(xiě)詞被更廣泛使用，像URL，HTML)。ActionForm類(lèi)的命名：以有意義的拼音縮寫(xiě)開(kāi)頭后加ActionFormAction類(lèi)的命名：以有意義的

6、拼音縮寫(xiě)開(kāi)頭后加Action2.3Class變量的命名變量名應(yīng)選用易于記憶、簡(jiǎn)短富于描述并能夠指出其用途的單詞。單詞不應(yīng)以下劃線或美元符號(hào)開(kāi)頭，除一次性臨時(shí)變量外盡量避免單個(gè)字符的變量名。除了變量名外，所有實(shí)例，包括類(lèi)、類(lèi)常量均采用大小寫(xiě)混合的方式，第一個(gè)單詞的首字母小寫(xiě)，其后單詞的首字母大寫(xiě)。charc（c、d、e常用于表示字符型）intI（i、j、k、m、n常用于表示整型）floatmyWidth;實(shí)例變量(InstanceVariables)大小寫(xiě)規(guī)則和變量名相似，但前面需要一個(gè)下劃線int_employeeId;String_name;Customer_customer;常量

7、(Constants)類(lèi)常量和ANSI常量的聲明，應(yīng)該全部大寫(xiě)，單詞間用下劃線隔開(kāi)。(盡量避免ANSI常量，容易引起錯(cuò)誤)staticfinalintMIN_WIDTH=4;staticfinalintMAX_WIDTH=999;staticfinalintGET_THE_CPU=1;....除了以下幾個(gè)特例之外，命名時(shí)應(yīng)始終采用完整的英文描述符。此外，一般應(yīng)采用小寫(xiě)字母，但類(lèi)名、接口名以及任何非初始單詞的第一個(gè)字母要大寫(xiě)。1、盡量使用完整的英文描述符2、