Android开发规范(简版)

Android开发规范

代码格式化 ctrl + alt + L

编辑文件后一定要 格式化，格式化，格式化

删除多余的 import ctrl + alt + O

行长限制 150

文件头注释规范

Settings -> Editor -> File and Code Templates -> Includes -> File Header

 /**
 * @author : 作者
 * @date   : ${DATE} ${TIME}
 * @desc   : 一句话功能描述/功能详细描述
 */

方便后续快速查看文件

TODO 去除自动导入的注释

TODO("not implemented") //To change body of created functions use File | Settings | File Templates.

merge request增加 改动的具体描述

():

type 必选
用于说明 commit 的类别，只允许使用下面7个标识。

feature：新功能
fix：修补bug
docs：文档（documentation）
style： 格式（不影响代码运行的变动）
refactor：重构（即不是新增功能，也不是修改bug的代码变动）
test：增加测试
chore：构建过程或辅助工具的变动

scope 可选
用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同

subject 必选
是 commit 目的的简短描述，不超过50个字。

例 Fix : 获取联系人 截取手机号长度报错

Commit 规范的作用

1.提供更多的信息，方便排查与回退；
2.过滤关键字，迅速定位；
3.方便生成文档；

ps: http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html 阮一峰的Commit message 和 Change log 编写指南