Android開發(fā)規(guī)范(簡版)

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 編寫指南

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末闽铐,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子奶浦,更是在濱河造成了極大的恐慌兄墅,老刑警劉巖,帶你破解...
    沈念sama閱讀 216,496評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件澳叉,死亡現(xiàn)場離奇詭異隙咸,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)成洗,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,407評論 3 392
  • 文/潘曉璐 我一進(jìn)店門五督,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人瓶殃,你說我怎么就攤上這事充包。” “怎么了遥椿?”我有些...
    開封第一講書人閱讀 162,632評論 0 353
  • 文/不壞的土叔 我叫張陵基矮,是天一觀的道長。 經(jīng)常有香客問我冠场,道長家浇,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,180評論 1 292
  • 正文 為了忘掉前任慈鸠,我火速辦了婚禮蓝谨,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘青团。我一直安慰自己,他們只是感情好咖楣,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,198評論 6 388
  • 文/花漫 我一把揭開白布督笆。 她就那樣靜靜地躺著,像睡著了一般诱贿。 火紅的嫁衣襯著肌膚如雪娃肿。 梳的紋絲不亂的頭發(fā)上咕缎,一...
    開封第一講書人閱讀 51,165評論 1 299
  • 那天,我揣著相機(jī)與錄音料扰,去河邊找鬼凭豪。 笑死,一個胖子當(dāng)著我的面吹牛晒杈,可吹牛的內(nèi)容都是我干的嫂伞。 我是一名探鬼主播,決...
    沈念sama閱讀 40,052評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼拯钻,長吁一口氣:“原來是場噩夢啊……” “哼帖努!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起粪般,我...
    開封第一講書人閱讀 38,910評論 0 274
  • 序言:老撾萬榮一對情侶失蹤拼余,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后亩歹,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體匙监,經(jīng)...
    沈念sama閱讀 45,324評論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,542評論 2 332
  • 正文 我和宋清朗相戀三年小作,在試婚紗的時候發(fā)現(xiàn)自己被綠了舅柜。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,711評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡躲惰,死狀恐怖致份,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情础拨,我是刑警寧澤氮块,帶...
    沈念sama閱讀 35,424評論 5 343
  • 正文 年R本政府宣布,位于F島的核電站诡宗,受9級特大地震影響滔蝉,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜塔沃,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,017評論 3 326
  • 文/蒙蒙 一蝠引、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧蛀柴,春花似錦螃概、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,668評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至制肮,卻和暖如春冒窍,著一層夾襖步出監(jiān)牢的瞬間递沪,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,823評論 1 269
  • 我被黑心中介騙來泰國打工综液, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留款慨,地道東北人。 一個月前我還...
    沈念sama閱讀 47,722評論 2 368
  • 正文 我出身青樓谬莹,卻偏偏與公主長得像檩奠,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子届良,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,611評論 2 353