Android/Java代碼規(guī)范

1、引入包的要求(import)

a倚舀、引入類時(shí)必需寫全類的完整路徑叹哭,即不能使用*導(dǎo)入所需的類

b、不能導(dǎo)入沒有使用的類


2痕貌、代碼注釋

ps:類风罩、成員變量、常量舵稠、方法函數(shù)都必須使用javadoc格式注釋

a超升、類注釋

標(biāo)注作者:必須是漢字,最多5個(gè)字符

b哺徊、方法函數(shù)注釋(包含參數(shù)名與返回值得注釋)

c廓俭、成員變量、常量注釋


3唉工、命名規(guī)范

a、包名規(guī)范:首字母小寫汹忠,可包含數(shù)字淋硝,不能用下劃線

b、常量規(guī)范:static需要寫在final前面宽菜,字母必須大寫谣膳,用下劃線分割,可以包含數(shù)字铅乡,字符長度1-40

c继谚、靜態(tài)變量規(guī)范(static,non-final fields)首字母小寫,駝峰標(biāo)示阵幸,不能用下劃線花履,字符長度1-25

d、成員變量規(guī)范:首字母小寫挚赊,駝峰標(biāo)示诡壁,可用下劃線(model類適配前端),字符長度1-25

e荠割、參數(shù)名規(guī)范:首字母小寫妹卿,駝峰標(biāo)示旺矾,可用下劃線(model類適配前端),字符長度1-25

f夺克、方法名規(guī)范:首字母小寫箕宙,駝峰標(biāo)示,不能用下劃線铺纽,字符長度1-25


4柬帕、其他代碼規(guī)范

a、方法的左大括號(hào)“{”代碼同一行顯示室囊,右大括號(hào)“}”需新建一行

b雕崩、代碼需要縮進(jìn)

c、每行只能定義一個(gè)變量

d融撞、數(shù)組定義采用java風(fēng)格盼铁,即:int[]?num;非:int?num[]尝偎;

e饶火、TODO是javaIDE自動(dòng)生成的。一般代碼寫完后要去掉致扯。

f肤寝、一個(gè)文件類的代碼行數(shù)不能超過2500行,一個(gè)方法不能超過300行抖僵,一行不能超過200個(gè)字符

g鲤看、如果是工具類,里面全是static方法耍群,請寫一個(gè)private的構(gòu)造函數(shù)义桂,避免外部new

h、long類型賦值時(shí)如果有加大寫’L’蹈垢,不要用小寫’l’慷吊,因?yàn)榕c數(shù)字1相似(例如:100L)

i、switch必須要有default

j曹抬、switch中case后需要加入了跳出語句溉瓶,例如:return、break谤民、throw堰酿、continue

k、構(gòu)造方法的參數(shù)不能超過10個(gè)赖临,方法參數(shù)不能超過10個(gè)

m胞锰、if-else嵌套語句個(gè)數(shù) 最多4層

l、try-catch?嵌套語句個(gè)數(shù)?最多2層

n兢榨、一個(gè)方法的return不能超過5個(gè)

o嗅榕、boolean值不能有冗余 比如if (b == true), b || true, !false

p顺饮、檢查是否存在過度復(fù)雜的boolean返回值

q、只有私有構(gòu)造器的類必須聲明為final

r凌那、interface方法不要用public兼雄、abstract修復(fù)

s、字符串比較必須使用equals(),而不是==

t帽蝶、檢查在重寫了equals方法后是否重寫了hashCode方法

u赦肋、成員變量用private修飾并提供get set方法給外部使用刃永,不可直接用public修飾

總結(jié):在save代碼之前司志,請先格式化代碼,eclipse快捷鍵 ctrl+shirt+F念恍,android studio快捷鍵ctrl+opt+L


5驹尼、checkstyle配置

android studio:

1趣避、插件安裝

2、配置checkstyle.xml文件

3新翎、檢測代碼


eclipse程帕、myEclipse自行百度

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市地啰,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌亏吝,老刑警劉巖,帶你破解...
    沈念sama閱讀 216,470評(píng)論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件枫攀,死亡現(xiàn)場離奇詭異,居然都是意外死亡株茶,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,393評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門图焰,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人技羔,你說我怎么就攤上這事√倮模” “怎么了鳖粟?”我有些...
    開封第一講書人閱讀 162,577評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長拙绊。 經(jīng)常有香客問我向图,道長,這世上最難降的妖魔是什么嗜傅? 我笑而不...
    開封第一講書人閱讀 58,176評(píng)論 1 292
  • 正文 為了忘掉前任檩赢,我火速辦了婚禮,結(jié)果婚禮上贞瞒,老公的妹妹穿的比我還像新娘。我一直安慰自己军浆,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,189評(píng)論 6 388
  • 文/花漫 我一把揭開白布拍冠。 她就那樣靜靜地躺著簇抵,像睡著了一般。 火紅的嫁衣襯著肌膚如雪碟摆。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,155評(píng)論 1 299
  • 那天断盛,我揣著相機(jī)與錄音愉舔,去河邊找鬼钢猛。 笑死轩缤,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的壶愤。 我是一名探鬼主播,決...
    沈念sama閱讀 40,041評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼馏鹤,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了勃救?” 一聲冷哼從身側(cè)響起碍讨,我...
    開封第一講書人閱讀 38,903評(píng)論 0 274
  • 序言:老撾萬榮一對(duì)情侶失蹤垄开,失蹤者是張志新(化名)和其女友劉穎税肪,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體益兄,經(jīng)...
    沈念sama閱讀 45,319評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,539評(píng)論 2 332
  • 正文 我和宋清朗相戀三年疑枯,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了蛔六。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,703評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡具钥,死狀恐怖液兽,靈堂內(nèi)的尸體忽然破棺而出骂删,到底是詐尸還是另有隱情四啰,我是刑警寧澤,帶...
    沈念sama閱讀 35,417評(píng)論 5 343
  • 正文 年R本政府宣布欧瘪,位于F島的核電站匙赞,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏罚屋。R本人自食惡果不足惜嗅绸,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,013評(píng)論 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望鱼鸠。 院中可真熱鬧羹铅,春花似錦愉昆、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,664評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽专肪。三九已至堪侯,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間伍宦,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,818評(píng)論 1 269
  • 我被黑心中介騙來泰國打工关贵, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留滓玖,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,711評(píng)論 2 368
  • 正文 我出身青樓翩肌,卻偏偏與公主長得像,于是被迫代替她去往敵國和親念祭。 傳聞我的和親對(duì)象是個(gè)殘疾皇子碍侦,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,601評(píng)論 2 353

推薦閱讀更多精彩內(nèi)容

  • 推薦文章:禪與 Objective-C 編程藝 前言 為??高產(chǎn)品代碼質(zhì)量,指導(dǎo)廣大軟件開發(fā)人員編寫出簡潔、可維護(hù)瓷产、...
    WolfTin閱讀 2,757評(píng)論 0 1
  • 老碼農(nóng)如何編寫無法維護(hù)的代碼 讓自己穩(wěn)拿鐵飯碗 :D — Roedy Green(翻譯版略有刪節(jié)) 簡介 永遠(yuǎn)不要...
    Clemente閱讀 1,095評(píng)論 0 2
  • Android編碼規(guī)范 源文件基礎(chǔ) 文件名 源文件以其最頂層的類名來命名濒旦,大小寫敏感,文件擴(kuò)展名為.java。 文...
    呼呼哥閱讀 941評(píng)論 0 0
  • 說明命名盡量做到見名知意锉矢,采用駝峰標(biāo)識(shí)齿尽,禁止使用拼音或者表意不明確的標(biāo)識(shí)(比如bianliang、i循头、j);命名無...
    hahaoop閱讀 940評(píng)論 0 5
  • vi /etc/profile -> export FORCE_UNSAFE_CONFIGURE=1 -> sou...
    金哲虎閱讀 2,543評(píng)論 0 1