java及android編碼規(guī)范

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

1、Java&Android編碼規(guī)范Java&Android編碼規(guī)范1/31Java&Android編碼規(guī)范目錄前言41代碼布局51.1基本格式51.2對齊61.3空行空格71.4斷行92注釋122.1實(shí)現(xiàn)注釋122.2文檔注釋173命名規(guī)則204聲明245表達(dá)式與語句256類和接口297Android313/31Java&Android編碼規(guī)范前言編寫本規(guī)范的目的是為了進(jìn)一步規(guī)范JAVA軟件編程風(fēng)格，提高軟件源程序的可讀性、可靠性和可重用性，確保在開發(fā)成員或開發(fā)團(tuán)隊(duì)之間的工作可以順利交接，不必花很大的力氣便能理解已編寫的代碼，以便繼續(xù)維護(hù)和改進(jìn)以前的工作，提高軟件源程序的質(zhì)量和可維護(hù)性

2、，減少軟件維護(hù)成本。本規(guī)范的內(nèi)容包括：代碼布局、注釋、命名規(guī)則、聲名、表達(dá)式與語句、類與接口等。本規(guī)范分成規(guī)則性和建議性兩種：對于規(guī)則性規(guī)范，要求所有軟件開發(fā)人員嚴(yán)格執(zhí)行；對于建議性規(guī)范，開發(fā)人員可以根據(jù)實(shí)際情況選擇執(zhí)行。自本規(guī)范實(shí)施之日起，以后新編寫的和修改的代碼均應(yīng)執(zhí)行本規(guī)范。本規(guī)范用到的術(shù)語解釋如下：規(guī)則：編程時必須遵守的規(guī)則。建議：編程時必須加以考慮的原則。說明：對相應(yīng)規(guī)則的必要的解釋。正例：對此規(guī)則或建議給出的修正后的例子。反例：對此規(guī)則或建議給出的反面的例子。3/31Java&Android編碼規(guī)范1代碼布局代碼布局的目的是顯示出程序良好的邏輯結(jié)構(gòu)，提高程序的準(zhǔn)確性、連續(xù)

3、性、可讀性、可維護(hù)性。更重要的是，統(tǒng)一的代碼布局和編程風(fēng)格，有助于提高整個項(xiàng)目的開發(fā)質(zhì)量，提高開發(fā)效率，降低開發(fā)成本。同時，對于普通程序員來說，養(yǎng)成良好的編程習(xí)慣有助于提高自己的編程水平，提高編程效率。因此，統(tǒng)一的、良好的程序布局和編程風(fēng)格不僅僅是個人主觀美學(xué)上的或是形式上的問題，而且涉及到產(chǎn)品質(zhì)量，涉及到個人編程能力的提高，必須要引起重視。1.1基本格式【規(guī)則1-1-1】源代碼文件（.java）的布局順序是：包、import語句、類。正例:packagecom.sunsharp;importjava.awt.peer.CanvasPeer;importjava.io.*;publi

4、cclassClassName{}【規(guī)則1-1-2】遵循統(tǒng)一的布局順序來書寫import語句，不同類別的import語句之間用空行分隔。說明：package語句其后可跟import語句，而且與package間隔一個空行。import包的排列順序?yàn)閖ava開頭的包在最前面，接下來是引自外部的包，再接下來是應(yīng)用程序自身的包，即import中標(biāo)準(zhǔn)的包名要在本地的包名之前，而且按照字母順序排列。正例:packagecom.sunsharp;importjava.util.ArrayList;//java自身的包importjava.util.List;importorg.apache.htt

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

6、中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰。說明：這樣便于程序閱讀和查找。正例：length=10;width=5;//矩形的長與寬關(guān)系較密切，放在一起。strCaption=“Test”;反例：length=10;strCaption=“Test”;width=5;1.1對齊【規(guī)則1-2-1】一般禁止使用制表符，必須使用空格進(jìn)行縮排。縮進(jìn)為4個空格。說明：對于利用Eclipse等編程工具的，可以設(shè)置TAB鍵為4個空格代替。消除不同編輯器對制表符處理的差異?！疽?guī)則1-2-2】程序的分界符‘{’和‘}’應(yīng)獨(dú)占一行，‘}’同時與引用它們的語句左對齊。{}之內(nèi)的代碼塊使用縮進(jìn)規(guī)則對齊。說明：這樣使代

7、碼便于閱讀，并且方便注釋。do…while語句可以例外，while條件可與}在同一行。正例：voidfunction(intvar){while(condition){31/31Java&Android編碼規(guī)范doSomething();//與{}縮進(jìn)4格}//與引用它們的模塊左對齊}反例：voidfunction(intvar){while(condition){doSomething();}}【規(guī)則1-2-3】多維的數(shù)組如果在定義時初始化，按照數(shù)組的矩