java編碼規(guī)范-細(xì)則

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

1、技術(shù)文件技術(shù)文件名稱(chēng)：Java編碼規(guī)范-細(xì)則技術(shù)文件編號(hào)：版本：1.3共38頁(yè)(包括封面)擬制　審核會(huì)簽標(biāo)準(zhǔn)化批準(zhǔn)中興通訊股份有限公司質(zhì)企中心IT部第1頁(yè)共36頁(yè)Java編碼規(guī)范-細(xì)則目錄前言41范圍52術(shù)語(yǔ)和定義52.1原則52.2規(guī)則52.3建議52.4說(shuō)明52.5正例52.6反例53代碼布局53.1基本格式53.2對(duì)齊73.3空行空格83.4斷行94注釋115命名規(guī)則166聲明227表達(dá)式與語(yǔ)句238類(lèi)和接口279附編程實(shí)例29第4頁(yè)共36頁(yè)Java編碼規(guī)范-細(xì)則版本變更記錄版本號(hào)擬制/修改日期擬制/修改人修改記錄批準(zhǔn)人1.1200

2、4-7-15于平刪去基本原則部分，在規(guī)范總則中體現(xiàn)；對(duì)注釋部分進(jìn)行修改；增加編程實(shí)例;修改部分命名規(guī)則。2004-10-9陳沛增加了類(lèi)編號(hào)說(shuō)明;取消類(lèi)頭的方法屬性列表要求；取消方法編號(hào)要求。1.32005-3-16韓榮華根據(jù)過(guò)程資產(chǎn)庫(kù)架構(gòu)指南調(diào)整文件名及引用陳沛注：1）擬制、審核、會(huì)簽、批準(zhǔn)不走電子流程時(shí)，必須用鋼筆或簽字筆填寫(xiě)，不得用鉛筆、圓珠筆填寫(xiě)，不得涂改。<本模板中用“<>”括起來(lái)的內(nèi)容包括本段，是編寫(xiě)指導(dǎo)，在最終的文檔中應(yīng)予以刪除。其它內(nèi)容應(yīng)予以保留。如果某節(jié)內(nèi)容無(wú)需填寫(xiě)，則在該節(jié)下寫(xiě)“無(wú)”，而不要將本節(jié)刪除或不填寫(xiě)任何內(nèi)容（留

3、白將無(wú)法判斷：是本節(jié)內(nèi)容無(wú)需填寫(xiě)還是因?yàn)槭韬龆颂顚?xiě)。）>第4頁(yè)共36頁(yè)Java編碼規(guī)范-細(xì)則前言編碼規(guī)范包括總則和細(xì)則兩部分?？倓t部分是對(duì)編碼的總體性規(guī)范要求，適用于多種編碼語(yǔ)言；細(xì)則部分是在總則的規(guī)范要求下，針對(duì)具體語(yǔ)言的特點(diǎn)而提出的規(guī)范要求。本規(guī)范是編碼規(guī)范的細(xì)則部分，適用于JAVA編程語(yǔ)言。編寫(xiě)本規(guī)范的目的是為了進(jìn)一步規(guī)范JAVA軟件編程風(fēng)格，提高軟件源程序的可讀性、可靠性和可重用性，確保在開(kāi)發(fā)成員或開(kāi)發(fā)團(tuán)隊(duì)之間的工作可以順利交接，不必花很大的力氣便能理解已編寫(xiě)的代碼，以便繼續(xù)維護(hù)和改進(jìn)以前的工作，提高軟件源程序的質(zhì)量和可維護(hù)性

4、，減少軟件維護(hù)成本。本規(guī)范的內(nèi)容包括：代碼布局、注釋、命名規(guī)則、聲名、表達(dá)式與語(yǔ)句、類(lèi)與接口等。規(guī)范最后給出了一個(gè)編程實(shí)例供軟件人員參考。本規(guī)范分成規(guī)則性和建議性?xún)煞N：對(duì)于規(guī)則性規(guī)范，要求所有軟件開(kāi)發(fā)人員嚴(yán)格執(zhí)行；對(duì)于建議性規(guī)范，各項(xiàng)目編程人員可以根據(jù)實(shí)際情況選擇執(zhí)行。自本規(guī)范實(shí)施之日起，以后新編寫(xiě)的和修改的代碼均應(yīng)執(zhí)行本規(guī)范第4頁(yè)共36頁(yè)Java編碼規(guī)范-細(xì)則36第36頁(yè)共36頁(yè)Java編碼規(guī)范-細(xì)則1范圍本標(biāo)準(zhǔn)規(guī)定了Java語(yǔ)言的編程規(guī)范，主要包括基本原則、布局、注釋、命名規(guī)則、聲明、表達(dá)式與語(yǔ)句、類(lèi)和接口等。本規(guī)范自生效之日起，對(duì)以

5、后新編寫(xiě)的和修改的代碼有約束力。2術(shù)語(yǔ)和定義下列術(shù)語(yǔ)和定義適用于本標(biāo)準(zhǔn)。2.1原則編程時(shí)應(yīng)該堅(jiān)持的指導(dǎo)思想。2.2規(guī)則編程時(shí)必須遵守的約定。2.3建議編程時(shí)必須加以考慮的約定。2.4說(shuō)明對(duì)此規(guī)則或建議的必要的解釋。2.5正例對(duì)此規(guī)則或建議給出的正確例子。2.6反例對(duì)此規(guī)則或建議給出的反面例子。3代碼布局代碼布局的目的是顯示出程序良好的邏輯結(jié)構(gòu)，提高程序的準(zhǔn)確性、連續(xù)性、可讀性、可維護(hù)性。更重要的是，統(tǒng)一的代碼布局和編程風(fēng)格，有助于提高整個(gè)項(xiàng)目的開(kāi)發(fā)質(zhì)量，提高開(kāi)發(fā)效率，降低開(kāi)發(fā)成本。同時(shí)，對(duì)于普通程序員來(lái)說(shuō)，養(yǎng)成良好的編程習(xí)慣有助于提高自己

6、的編程水平，提高編程效率。因此，統(tǒng)一的、良好的程序布局和編程風(fēng)格不僅僅是個(gè)人主觀美學(xué)上的或是形式上的問(wèn)題，而且涉及到產(chǎn)品質(zhì)量，涉及到個(gè)人編程能力的提高，必須要引起重視。3.1基本格式【規(guī)則3-1-1】源代碼文件（.java）的布局順序是：包、import語(yǔ)句、類(lèi)。正例:packagecom.zte;36第36頁(yè)共36頁(yè)Java編碼規(guī)范-細(xì)則importjava.awt.peer.CanvasPeer;importjava.io.*;importcom.zte.ums.uep.*;publicclassClassName{}【規(guī)則3-1-2

7、】遵循統(tǒng)一的布局順序來(lái)書(shū)寫(xiě)import語(yǔ)句，不同類(lèi)別的import語(yǔ)句之間用空行分隔。說(shuō)明：package語(yǔ)句其后可跟import語(yǔ)句，而且與package間隔一個(gè)空行。import包的排列順序?yàn)閖ava開(kāi)頭的包在最前面，接下來(lái)是引自外部的包，再接下來(lái)是應(yīng)用程序自身的包，即import中標(biāo)準(zhǔn)的包名要在本地的包名之前，而且按照字母順序排列。正例:packagecom.zte;importjava.awt.peer.CanvasPeer;//java自身的包importjava.io.*;importcom.klg.field.*;//第三方

8、的包importcom.zte.ums.uep.*;//程序自身的包【規(guī)則3-1-3】if、else、elseif、for、while、do等語(yǔ)句獨(dú)占一行，執(zhí)行語(yǔ)句不得緊跟其后。不論執(zhí)行語(yǔ)句有