android java代碼規(guī)范

《android java代碼規(guī)范》由會員上傳分享，免費在線閱讀，更多相關(guān)內(nèi)容在教育資源-天天文庫。

1、AndroidJAVA開發(fā)代碼與注釋規(guī)范說明：1本代碼規(guī)范如有不合理的地方可以提出進行修改，對于規(guī)范有建議可以提出添加，該規(guī)范只是個初版，后期可以進行完善并執(zhí)行。2本規(guī)范旨在提高代碼可讀性，讓接手項目的人可以節(jié)省代碼閱讀時間成本。最終主旨可以做到，讓小白程序猿都可以看清代碼邏輯1代碼規(guī)范1.1縮進風(fēng)格程序塊要采用縮進風(fēng)格編寫，縮進的空格數(shù)為4個。說明：對于由開發(fā)工具自動生成的代碼可以有不一致。1.2分界符’{’和’}’應(yīng)與所修改文件或新建文件所在的工程或模塊保持一致。分界符’{’和’}’獨占一列，與引用它們的語句左對齊，并且不允許空行。（雖然Android中要求分界符

2、’{’不獨占一行，但是個人認為分界符獨占一行會更有助于代碼結(jié)構(gòu)的整理，可以單獨區(qū)分模塊）在函數(shù)體的開始、類和借口的定義、以及if、for、do、switch、case語句中的程序都要采用如上的縮進風(fēng)格示例：不符合規(guī)范for(…){…//programcode}voidexample_fun(void){…//programcode}符合規(guī)范for(…){…//programcode}voidexample_fun(void){…//programcode}1.3較長的語句、表達式參數(shù)較長的語句、表達式活著參數(shù)(>100字符)要分成多行書寫，長表達式要在低優(yōu)先級操作符處

3、劃分新行，操作符放在新行之首，劃分出的新行要進行適當(dāng)?shù)目s進，使排版整齊，語句可讀示例：if(datas！=null&&arraylist.size

4、句自占一行，且無論執(zhí)行語句有多少都要加括號{}。示例：不規(guī)范代碼if(true)return;應(yīng)書寫如下：if(true){return;}1.6相對獨立的程序塊之間、變量說明之后必須加空行。示例：不規(guī)范代碼：if(true){return}Strings1;應(yīng)書寫如下：if(true){return}Strings1;1.7對齊只使用空格，不使用TAB鍵。（TAB鍵長度為4個空格）說明：以免用不同的編輯器閱讀程序時，因TAB鍵所設(shè)置的空格數(shù)目不同而造成程序布局不整齊。1.8關(guān)鍵字、變量、常量進行對等操作在兩個以上的關(guān)鍵字、變量、常量進行操作時，它們之間的操作符之前、

5、之后或者前后要加空格；進行非對等操作時，如果是關(guān)系密切的立即操作符(如.)，后面不加空格。說明：采用這種方式編寫代碼的目的是為了使代碼更加清晰。由于留空格所產(chǎn)生的清晰性是相對的，所以在非常清晰的語句中沒有必要留空格。示例：(1)逗號、分號只在后面加空格。Stringa,b,c;(2)比較操作符“>=”、“==”，賦值操作符“=”、“+=”，算數(shù)操作符“+”、“%”，邏輯操作符“&&”，位域操作符“<<”的前后加空格。if(a>=b)a=b+c;a+=2;a=b+2;(3)地址運算符“！”、“++”、“&”等操作符前后不加空格bool=!true;i++;(4)if、f

6、or、while、switch等后面的括號間應(yīng)加空格，可以使關(guān)鍵字更為突出if(true)(5)一行程序的長度不宜過長，以小于80個字符為宜2注釋2.1一般情況下，源代碼的有效注釋量必須在20%以上說明：注釋的原則是有助于對程序的閱讀理解，在改加的地方都加，盡量做到明確，易懂，簡潔。2.2類說明性注釋說明：在每個類的頭部，都應(yīng)該列出生成時間，作者，功能，修改歷史修改歷史在每次對該類進行修改的時候進行添加示例：/***生成時間：2017-09-10*作者：wyj*功能：這是一個界面*生成版本號：1.1.0*修改歷史：*作者，版本，新增功能，新增時間(這里盡量用簡述)*(

7、其他的語言進行注釋的時候可能需要有其他說明，可在添加)*/publicclassactivity(){}2.3功能性方法說明性注釋說明：在功能性方法的頭部，都應(yīng)該列出該方法的時間，作者，功能，返回值，傳入?yún)?shù)，以及修改歷史示例：/***時間：2017-09-10*作者：wyj*功能：這是一個方法*return：這里返回一個字符串（返回值說明）*s1:這是第一個參數(shù)（參數(shù)說明）*s2:這是第二個參數(shù)（）*修改歷史：（同2.2）*/publicintdata(Strings1,Strings2){returns1}2.4要養(yǎng)成邊寫代碼邊注釋的習(xí)慣，修改代