編碼規(guī)范細(xì)則_Java.doc

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

1、技術(shù)文件技術(shù)文件名稱：編碼規(guī)范細(xì)則_Java技術(shù)文件編號：版本：1.0共37頁(包括封面)擬制　審核會簽標(biāo)準(zhǔn)化批準(zhǔn)目錄前言41范圍52術(shù)語和定義52.1原則52.2規(guī)則52.3建議52.4說明52.5正例52.6反例53代碼布局53.1基本格式53.2對齊73.3空行空格83.4斷行94注釋115命名規(guī)則166聲明227表達(dá)式與語句228類和接口269附編程實(shí)例28版本變更記錄版本號擬制/修改日期擬制/修改人修改記錄批準(zhǔn)人注：1）擬制、審核、會簽、批準(zhǔn)不走電子流程時(shí)，必須用鋼筆或簽字筆填寫，不得用鉛筆、圓珠筆填寫，不得涂改。<本模板中用“<>”括

2、起來的內(nèi)容包括本段，是編寫指導(dǎo)，在最終的文檔中應(yīng)予以刪除。其它內(nèi)容應(yīng)予以保留。如果某節(jié)內(nèi)容無需填寫，則在該節(jié)下寫“無”，而不要將本節(jié)刪除或不填寫任何內(nèi)容（留白將無法判斷：是本節(jié)內(nèi)容無需填寫還是因?yàn)槭韬龆颂顚?。?前言編碼規(guī)范包括總則和細(xì)則兩部分?？倓t部分是對編碼的總體性規(guī)范要求，適用于多種編碼語言；細(xì)則部分是在總則的規(guī)范要求下，針對具體語言的特點(diǎn)而提出的規(guī)范要求。本規(guī)范是編碼規(guī)范的細(xì)則部分，適用于JAVA編程語言。編寫本規(guī)范的目的是為了進(jìn)一步規(guī)范JAVA軟件編程風(fēng)格，提高軟件源程序的可讀性、可靠性和可重用性，確保在開發(fā)成員或開發(fā)團(tuán)隊(duì)之間的工作

3、可以順利交接，不必花很大的力氣便能理解已編寫的代碼，以便繼續(xù)維護(hù)和改進(jìn)以前的工作，提高軟件源程序的質(zhì)量和可維護(hù)性，減少軟件維護(hù)成本。本規(guī)范的內(nèi)容包括：代碼布局、注釋、命名規(guī)則、聲名、表達(dá)式與語句、類與接口等。規(guī)范最后給出了一個(gè)編程實(shí)例供軟件人員參考。本規(guī)范分成規(guī)則性和建議性兩種：對于規(guī)則性規(guī)范，要求所有軟件開發(fā)人員嚴(yán)格執(zhí)行；對于建議性規(guī)范，各項(xiàng)目編程人員可以根據(jù)實(shí)際情況選擇執(zhí)行。自本規(guī)范實(shí)施之日起，以后新編寫的和修改的代碼均應(yīng)執(zhí)行本規(guī)范1范圍本標(biāo)準(zhǔn)規(guī)定了Java語言的編程規(guī)范，主要包括基本原則、布局、注釋、命名規(guī)則、聲明、表達(dá)式與語句、類和接口等

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

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

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

7、uep.*;//程序自身的包【規(guī)則3-1-3】if、else、elseif、for、while、do等語句獨(dú)占一行，執(zhí)行語句不得緊跟其后。不論執(zhí)行語句有多少都要加{}。說明：這樣可以防止書寫失誤，也易于閱讀。正例：if(varible1

8、10;width=5;//矩形的長與寬關(guān)系較密切，放在一起。strCaption=“Test”;反例：length=10;strCapt