Android工作总结:编码规范、git log规范

1.1 Git代码提交Comment规范
Bug ID: Bugzilla上的BugID填在这行
G-HIBIKI ID: 将日方问处编号填在这行
SR ID: 高通Case如果有的话将编号填在这行,没有的话为空
Redmine Feature ID: 对应Redmine Feature ID
ABSTRACT: 简单描述本次提交概要
Scratch or Copy [S/C]: 是纯手工编写(S)还是参考填(C)
Copy from: Scratch or Copy填C时,把源信息填在本行
Other Info: 补充信息

1.2 Git代码提交Comment的环境设定
1)请确认repo脚本的REPO_URL
vi `which repo`
#REPO_URL='git://android.git.kernel.org/tools/repo.git'
改为 REPO_URL='git://192.168.9.142/tools/repo.git'
2)切换到worktree的.repo/目录下,
例如: $cd YOUR_WORKTREE_DIR/.repo
$rm -rf repo
$git clone git://192.168.9.142/tools/repo.git
※完成后,如果在当前目录下的repo目录下看到ts_commit脚本,说明可以使用了。
3)提交代码时必须使用repo commit命令。

1.3 Bug Fix编码注释规范
1)无论在任何时候不能对代码进行物理删除,也就是说所谓的删除只是注释掉代码。

2)注释模板,各项意义说明参见※,start-end注释之间不能有对应外的内容。
/* Type YYYY/MM/DD Author Project Phase G-HIBIKI-ID start */
/* Type YYYY/MM/DD Author Project Phase G-HIBIKI-ID end */


Type:Modify/Add/Delete
YYYY/MM/DD:修改的日期,比如:2012/03/26
Author:XXXXSoft
Project:AD-MASTER_12-1st
Phase:T3
G-HIBIKI ID:问题在G-HIBIKI的编号
#不同的语言需更换相应的注释符号/* */。

3)删除代码注释
/* Delete 2012/03/26 XXXXSoft AD-MASTER_12-1st T3 Q85TS-PR1-00046 start */
/*要注释掉的代码*/
/* Delete 2012/03/26 XXXXSoft AD-MASTER_12-1st T3 Q85TS-PR1-00046 end */

4)添加代码注释
/* Add 2012/03/26 XXXXSoft AD-MASTER_12-1st T3 Q85TS-PR1-00046 start */
/*要添加的代码*/
/* Add 2012/03/26 XXXXSoft AD-MASTER_12-1st T3 Q85TS-PR1-00046 end */

5)修改代码注释
/* Modify 2012/03/26 XXXXSoft AD-MASTER_12-1st T3 Q85TS-PR1-00046 start */
/*修改前的代码*/
修改后的代码
/* Modify 2012/03/26 XXXXSoft AD-MASTER_12-1st T3 Q85TS-PR1-00046 end */

1.4 其它规范
1)代码必须通过 gerrit提交,提交者自行Review后提交到gerrit,
然后经由至少2名Reviewer的代码审查通过后,方可推送入库。

2)代码文件的乱码问题要注意,因为来自不同源的代码可能编码格式不是一样的。

3)编码要遵循Android编码规范,详细参考如下规范文档:
http://source.android.com/source/code-style.html

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值