資源描述:
《軟件開發(fā)代碼規(guī)范(Java)》由會(huì)員上傳分享,免費(fèi)在線閱讀,更多相關(guān)內(nèi)容在行業(yè)資料-天天文庫。
1、.....軟件開發(fā)代碼規(guī)范(C)(僅通普信息技術(shù)股份有限公司供內(nèi)部使用)擬制:楊超日期:2015-3-10審核:夏峰日期:2015-3-10核準(zhǔn):馮敬剛?cè)掌冢?015-3-17簽發(fā):韓殿成日期:2015-3-21文檔版本:V1.11.專業(yè)word可編輯......黑龍江通普信息技術(shù)股份有限公司版本歷史日期版本說明作者.專業(yè)word可編輯.......專業(yè)word可編輯......目錄第一章代碼開發(fā)規(guī)范及其指南11.1目的11.2程序內(nèi)命名規(guī)范11.3文件命名規(guī)范21.4Java文件樣式21.5代
2、碼編寫格式6第二章程序編寫規(guī)范方法82.1權(quán)限修飾82.2其他規(guī)范82.3編程指南10第三章其他要求12.專業(yè)word可編輯.......專業(yè)word可編輯.......專業(yè)word可編輯......第一章代碼開發(fā)規(guī)范及其指南1.1目的定義這個(gè)規(guī)范的目的是讓項(xiàng)目中所有的文檔都看起來像一個(gè)人寫的,增加可讀性,減少項(xiàng)目組中因?yàn)閾Q人而帶來的損失。(這些規(guī)范并不是一定要絕對(duì)遵守,但是一定要讓程序有良好的可讀性)1.2程序內(nèi)命名規(guī)范lPackage的命名:Package的名字應(yīng)該都是由一個(gè)小寫單詞組成。l
3、Class的命名:Class的名字必須由大寫字母開頭而其他字母都小寫的單詞組成lClass變量的命名:變量的名字必須用一個(gè)小寫字母開頭。后面的單詞用大寫字母開頭。lStaticFinal變量的命名:StaticFinal變量的名字應(yīng)該都大寫,并且指出完整含義。l參數(shù)的命名:參數(shù)的名字必須和變量的命名規(guī)范一致。l數(shù)組的命名:數(shù)組應(yīng)該總是用下面的方式來命名:byte[]buffer;而不是bytebuffer[];l方法的參數(shù):.專業(yè)word可編輯......使用有意義的參數(shù)命名,如果可能的話,使用
4、和要賦值的字段一樣的名字:SetCounter(intsize){this.size=size;}1.1文件命名規(guī)范l文件名由英文單詞組成,每個(gè)單詞的首字母大寫,不要超過4個(gè)單詞,如ShipOrder.jsp。lJava文件的文件名要與程序中的public類名相同。lServet文件要以Servlet做為結(jié)尾,如AddCompanyServlet.javal業(yè)務(wù)處理組件JavaBean要以Bean為結(jié)尾,如ProcessBean.java1.2Java文件樣式所有的Java(*.java)文件都
5、必須遵守如下的樣式規(guī)則l頭部版權(quán)信息版權(quán)信息必須在java文件的開頭,比如:/***Copyright2002SunMicrosystems,Inc.Allrightsreserved.*/其他不需要出現(xiàn)在javadoc的信息也可以包含在這里。.專業(yè)word可編輯......lPackage/Importspackage行要在import行之前,import中標(biāo)準(zhǔn)的包名要在本地的包名之前,而且按照字母順序排列。如果import行中包含了同一個(gè)包中的不同子目錄,則應(yīng)該用*來處理。packageho
6、tlava.net.stats;importjava.io.*;importjava.util.Observable;importhotlava.util.Application;這里java.io.*使用來代替InputStreamandOutputStream的。lClass接下來的是類的注釋,一般是用來解釋類的相關(guān)信息,包括標(biāo)題、描述、。/***
Title:Example
*
Description:AuditApplicationExample
*
Copyri
7、ght:Copyright(c)200x
*
Company:xxxxx
*@authorxxxxxx.專業(yè)word可編輯......*@version1.0*/接下來是類定義,包含了在不同的行的extends和implementspublicclassCounterSetextendsObservableimplementsCloneablelClassFields接下來是類的成員變量:/***Packetcounters*/protectedint[]packets;publ
8、ic的成員變量必須生成文檔(JavaDoc)。protected、private和package定義的成員變量如果名字含義明確的話,可以沒有注釋。l存取方法接下來是類變量的存取的方法。它只是簡(jiǎn)單的用來將類的變量賦值獲取值的話,可以簡(jiǎn)單的寫在一行上。/***Getthecounters.專業(yè)word可編輯......*@returnanarraycontainingthestatisticaldata.Thisarrayhasbeen*freshlyallocatedandcanbemodifie