1.利用androidstudio生成javadoc
非常簡單,看下圖,幾個主要事項全部寫在截圖的標註上了,注意一下下哦:
選擇我們要生成doc的項目
設置導出的配置(-encoding utf-8 -charset utf-8)
大功告成!
2.基本的代碼代碼規範
- 包名格式:域名反轉+項目名,小寫。比如site.zhangyun.theone. zhangyun.site爲我的域名,theone爲項目名。
- 類名:駝峯首字母大寫,比如:MainActivity
- 類中final類型的變量全部大寫,用下劃線做分割。比如:
public final static String AUTONOMIC_SPEECH_ACTION = "com.efrobot.robot.action.AUTONOMIC_SPEECH";
- 類中public類型的變量寫最前面,先寫public申明,再寫protected,再申明private
- 類中成員變量以小寫m開頭,比如:mContext.
- 類中靜態變量以小寫s開頭,比如:sInstance.
- 每一行變量申明寫完或者每個方法寫完後空一行再寫下一個
- 方法裏面的變量名小寫
目前記住的就這些了,等下次記住新的了再補上,如果對自己要求高的可以安裝一個checkstyle插件導入有名的華爲規範就可以自動幫您檢查了,或者用谷歌默認的規範