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自行百度