Android開發(fā)規(guī)范
代碼格式化 ctrl + alt + L
編輯文件后一定要 格式化,格式化署恍,格式化
刪除多余的 import ctrl + alt + O
行長限制 150
文件頭注釋規(guī)范
Settings -> Editor -> File and Code Templates -> Includes -> File Header
/**
* @author : 作者
* @date : ${DATE} ${TIME}
* @desc : 一句話功能描述/功能詳細(xì)描述
*/
方便后續(xù)快速查看文件
TODO 去除自動導(dǎo)入的注釋
TODO("not implemented") //To change body of created functions use File | Settings | File Templates.
merge request增加 改動的具體描述
<type>(<scope>): <subject>
type 必選
用于說明 commit 的類別登颓,只允許使用下面7個標(biāo)識舌镶。
feature:新功能
fix:修補(bǔ)bug
docs:文檔(documentation)
style: 格式(不影響代碼運(yùn)行的變動)
refactor:重構(gòu)(即不是新增功能炕舵,也不是修改bug的代碼變動)
test:增加測試
chore:構(gòu)建過程或輔助工具的變動
scope 可選
用于說明 commit 影響的范圍栋荸,比如數(shù)據(jù)層菇怀、控制層夷家、視圖層等等,視項(xiàng)目不同而不同
subject 必選
是 commit 目的的簡短描述敏释,不超過50個字库快。
例 Fix : 獲取聯(lián)系人 截取手機(jī)號長度報錯
Commit 規(guī)范的作用
1.提供更多的信息,方便排查與回退钥顽;
2.過濾關(guān)鍵字义屏,迅速定位;
3.方便生成文檔蜂大;
ps: http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html 阮一峰的Commit message 和 Change log 編寫指南