Android Bug修改注释规范

公司文档

---

版本	日期	作者	更新内容
1.0	2015-05-06	王恒	初稿
1.1	2015-05-07	王恒	APK命名方式添加渠道号

1、目的

• 防止误删
• 提高问题可追踪度
• 方便明确Bug责任
• 提高Bug修正可持续度

2、Java代码注释

在修改前和修改后分别添加注释，模板如下：

// modify start.日期.姓名.Bug号(如果有的话):Bug简单描述
// modify end.日期.姓名.Bug号(如果有的话):Bug简单描述

例子：

// modify start.2015-05-06.wangheng.12345:处理NullPointerException，添加保护
// getUI().finish();
if(null != getUI){
    getUI().finish();
}
// modify end.2015-05-06.wangheng.12345:处理NullPointerException，添加保护

3、Bug管理系统注释添加

模板：

【问题原因】:(问题产生的原因)
【解决方案】:(你的解决思路)
【解决DIFF】:(影响的代码)

例子：当解决万一个Bug之后，在禅道上添加注释

【问题原因】:getUI()方法有可能返回null
【解决方案】:在getUI()方法不返回null的时候才进行后续的处理
【解决DIFF】:UserPresenter.java success()方法第123行:
修改前：
getUI().finish();
修改后：
if(null != getUI){
    getUI().finish();
}

4. 打包APK文件命名规范

打包时一定要严格遵守刮目打包规范

格式如下：

guamu_版本号_debug或者release_渠道号日期今天第几个包.apk

例子：

guamu_1.2.1_debug_baidu_20150506-1.apk

表示打的包是刮目的1.2.1的Debug版本的baidu渠道包，打包日期是2015年5月6日，是当天的第一个包