資源描述:
《Java代碼書(shū)寫(xiě)規(guī)范(高手必經(jīng)之路)》由會(huì)員上傳分享,免費(fèi)在線(xiàn)閱讀,更多相關(guān)內(nèi)容在教育資源-天天文庫(kù)。
1、u符號(hào)命名規(guī)則符號(hào)名包括:模塊名,變量名,常量名,方法(函數(shù)/子程序)名,數(shù)據(jù)區(qū)名,緩沖區(qū)名等。符號(hào)命名通常應(yīng)遵循以下規(guī)則:通用規(guī)則:1、在所有命名中,都應(yīng)使用標(biāo)準(zhǔn)的英文單詞或縮寫(xiě)。不得使用拼音或拼音縮寫(xiě),除非該名字描述的是中文特有的內(nèi)容,如半角、全角,聲母、韻母等。2、所有命名都應(yīng)遵循達(dá)意原則,即名稱(chēng)應(yīng)含義清晰、明確。3、所有命名都不易過(guò)長(zhǎng),應(yīng)控制在規(guī)定的最大長(zhǎng)度以?xún)?nèi)。4、所有命名都應(yīng)盡量使用全稱(chēng)。5、如果命名使用縮寫(xiě),則必須對(duì)其進(jìn)行注釋和說(shuō)明。具體規(guī)范:1、工程名統(tǒng)一制訂。2、文件名文件名應(yīng)與類(lèi)名相同,這是java的規(guī)范3、方法名/
2、函數(shù)名2·方法名第一個(gè)單詞小寫(xiě)。2·推薦使用動(dòng)賓結(jié)構(gòu)。方法名應(yīng)清晰反映該方法的功能、用途。2·方法名最長(zhǎng)不得超過(guò)30個(gè)字符。例:getCollection();setCollection();insertObject();deleteObject();3、變量名必須使用有意義的變量名。推薦的類(lèi)型縮寫(xiě)(type)——·char:ch·boolean:b·int:i·long:l·double:d·float:f變量名最長(zhǎng)不得超過(guò)20個(gè)字符。4、類(lèi)名2·必須以大寫(xiě)字母開(kāi)頭,類(lèi)名反映具體含義,以清晰表達(dá)類(lèi)的用途和功能為原則2·當(dāng)名稱(chēng)由多個(gè)單詞
3、構(gòu)成時(shí),每一個(gè)單詞的第一個(gè)字母必須大寫(xiě)u代碼書(shū)寫(xiě)規(guī)范書(shū)寫(xiě)規(guī)范即在編寫(xiě)代碼過(guò)程中所使用的標(biāo)準(zhǔn)格式,主要包括空格的使用、括號(hào)的使用、縮近格式和其他一些內(nèi)容。源代碼書(shū)寫(xiě)規(guī)范1.在.java/.jsp的開(kāi)頭應(yīng)有一段格式統(tǒng)一的說(shuō)明,內(nèi)容包括:a.文件名(Title/FileName);b.創(chuàng)建人(Author);c.文件創(chuàng)建時(shí)間(Date);d.簡(jiǎn)短說(shuō)明文件功能、用途(Description/Function)。樣例:/***標(biāo)題:Schedule.java*描述:用來(lái)實(shí)現(xiàn)計(jì)劃項(xiàng)目審批*創(chuàng)建:2001-06-30*作者:趙文正*詳細(xì):詳細(xì)描述計(jì)劃
4、項(xiàng)目審批的細(xì)節(jié),如何根據(jù)細(xì)節(jié)功能確定方法*/2.除非極其簡(jiǎn)單,否則對(duì)函數(shù)應(yīng)有注釋說(shuō)明。內(nèi)容包括:功能、入口/出口參數(shù),必要時(shí)還可有備注或補(bǔ)充說(shuō)明。3.每行代碼的長(zhǎng)度推薦為80列,最長(zhǎng)不得超過(guò)120列;折行以對(duì)齊為準(zhǔn)。4.在類(lèi)的成員函數(shù)內(nèi)調(diào)用其他類(lèi)的成員函數(shù)時(shí),其他類(lèi)的成員函數(shù)可做簡(jiǎn)短說(shuō)明。6.函數(shù)入口參數(shù)有缺省值時(shí),應(yīng)注釋說(shuō)明。例:floatgetValue(intID,booleanflag){/*parameterdescriptionID:IdentifyNoflag:default=TRUE*/…}7.elseif必須寫(xiě)在一行。
5、8.與‘{’、‘}’有關(guān)的各項(xiàng)規(guī)定:① ‘{’、‘}’應(yīng)獨(dú)占一行。在該行內(nèi)可有注釋。例:正確:for(i=0;i0){m=1;n++;}不得寫(xiě)做:if(i>
6、0){m=1;n++;}①在循環(huán)、分支之后若只有一行代碼,雖然可省略‘{’、‘}’,但不推薦這么做。若省略后可能引起歧義,則必須加上‘{’、‘}’。例:正確:if(n==-2){n=1;}elseif(n!=nTemp){n=2;}else{n=3;}不得寫(xiě)做:if(n==-2)n=1;elseif(n!=nTemp)n=2;elsen=3;9.與空格有關(guān)的各項(xiàng)規(guī)定。①所有兩目、三目運(yùn)算符的兩邊都必須有空格。在單目運(yùn)算符兩端不必空格。但在‘.’、‘[’、‘]’等運(yùn)算符前后,及‘&’(取地址)等運(yùn)算符之后不得有空格。例:正確:intn=0
7、,nTemp;for(inti=nMinLine;i<=nMaxLine;i++)不得寫(xiě)做:intn=0,nTemp;for(inti=nMinLine;i<=nMaxLine;i++)②or、while、if等關(guān)鍵詞之后應(yīng)有1個(gè)空格,再接‘(’,之后無(wú)空格;在結(jié)尾的‘)’前不得有空格。例:正確:if(-2==n)不得寫(xiě)做:if(-2==n)或if(-2==n)等等。③調(diào)用函數(shù)時(shí),‘(’、‘)’前后不得有空格。④類(lèi)型強(qiáng)制轉(zhuǎn)換時(shí),‘(’‘)’前后不得有空格10.與縮進(jìn)有關(guān)的各項(xiàng)規(guī)定① 縮進(jìn)以Tab為單位。1個(gè)Tab為4個(gè)空格② 下列情況,
8、代碼縮進(jìn)一個(gè)Tab:函數(shù)體相對(duì)函數(shù)名及‘{’、‘}’。if、else、for、while、do等之后的代碼。一行之內(nèi)寫(xiě)不下,折行之后的代碼,應(yīng)在合理的位置進(jìn)行折行。若有+-*/等運(yùn)算符,則運(yùn)算符應(yīng)在上一行末