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

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

1、項目管理系統(tǒng)程序編碼規(guī)范V1.0程序編碼規(guī)范V1.0編寫：×××審核：×××××××年××月修改22項目管理系統(tǒng)程序編碼規(guī)范V1.0目錄一、引言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行末注釋(En

2、d-Of-LineComments)8四Java文件樣式84.1版權(quán)信息84.2Package/Imports94.3Class94.4ClassFields104.5存取方法104.6構(gòu)造函數(shù)104.7main方法114.8換行(WrappingLines)114.9行長度(LineLength)134.10語句(Statements)13五排版格式18六JSP編碼規(guī)范19七、文件與目錄20八、日志規(guī)范20九、設(shè)計及技巧建議219.1表現(xiàn)層229.2業(yè)務(wù)層229.3持久層2222項目管理系統(tǒng)程序編

3、碼規(guī)范V1.0一、引言編碼規(guī)范對于程序員而言尤為重要，有以下幾個原因：1、一個軟件的生命周期中，80%的花費在于維護(hù)。2、幾乎沒有任何一個軟件，在其整個生命周期中，均由最初的開發(fā)人員來維護(hù)。3、編碼規(guī)范可以改善軟件的可讀性，可以讓程序員盡快而徹底地理解新的代碼。4、如果你將源碼作為產(chǎn)品發(fā)布，就需要確任它是否被很好的打包并且清晰無誤，一如已構(gòu)建的其它任何產(chǎn)品為了執(zhí)行規(guī)范，每個軟件開發(fā)人員必須一致遵守編碼規(guī)范中的代碼規(guī)范，代碼規(guī)范提高軟件代碼的可讀性,使得開發(fā)人員快速和徹底的理解新代碼.。好的代碼風(fēng)格不

4、僅會提高可讀性，而且會使代碼更健壯，更為重要的是在修改時不容易出錯?，F(xiàn)代軟件開發(fā)中，維護(hù)工作會占用80%的時間，而且開發(fā)者和維護(hù)者通常不是同一個程序員。這意味著程序員經(jīng)常要閱讀和修改別人開發(fā)的程序，別人也同樣可能需要閱讀和修改你開發(fā)的程序，所以制定一套完善的編碼規(guī)范非常重要。定義本規(guī)范的目的是使項目中所有的文檔及程序編碼在寫作風(fēng)格上具有一致性，增加可讀性，減少項目組中因為換人帶來的損失，從而使程序具有良好的可讀性。二、命名規(guī)范2.1包（Package）的命名包(Packages)：一個唯一包名的前綴

5、應(yīng)全部為小寫的ASCII字母，并且是一個頂級域名，通常為com、edu、gov、mil、net、org等。包名的后續(xù)部分可根據(jù)各個不同機(jī)構(gòu)內(nèi)部的命名規(guī)范來定義，這類命名規(guī)范可以由特定的目錄名來區(qū)分部門(department)、項目(project)、機(jī)器(machine)和注冊名(loginnames)。l核心程序部分：com.xxxxxx.basel系統(tǒng)管理部分：com.xxxxxx.sys22項目管理系統(tǒng)程序編碼規(guī)范V1.0l應(yīng)用維護(hù)部分：com.xxxxxx.appconfigl項目計劃管理部

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

7、FormAction類的命名：以有意義的拼音縮寫開頭后加Action2.3Class變量的命名變量名應(yīng)選用易于記憶、簡短富于描述并能夠指出其用途的單詞。單詞不應(yīng)以下劃線或美元符號開頭，除一次性臨時變量外盡量避免單個字符的變量名。除了變量名外，所有實例，包括類、類常量均采用大小寫混合的方式，第一個單詞的首字母小寫，其后單詞的首字母大寫。charc（c、d、e常用于表示字符型）intI（i、j、k、m、n常用于表示整型）floatmyWidth;實例變量(InstanceVariables)大小寫規(guī)則和

8、變量名相似，但前面需要一個下劃線int_employeeId;String_name;Customer_customer;常量(Constants)類常量和ANSI常量的聲明，應(yīng)該全部大寫，單詞間用下劃線隔開。(盡量避免ANSI常量，容易引起錯誤)staticfinalintMIN_WIDTH=4;staticfinalintMAX_WIDTH=999;staticfinalintGET_THE_CPU=1;22項目管理系統(tǒng)程序編碼規(guī)范V1.0除了以下幾個特例之外，命