代码注释及代码提交规范

修改代码必须按照以下格式进行注释

l  修改代码必须按照以下格式进行注释:

         邮件              日期

// name@company.com2010.03.18 begin

// BUG NUBER 如#12345， 没有可以不写

// Comment(why modified)

// reviewed by xxx@company.com

  Xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx(修改部分代码)

// name@company.com2010.03.18 end

l  建立新的文件,需要有文件头信息,格式如下:

/*Filename                                                */

/* Detaildescription

 *xxxxxxxxxxxxxx

 *xxxxxxxxxxxxxx

 */

/*Author:xxxxx@company.com, created at2011/10/25              */

/*Modified by xxxxx@company.com , Modified at2011/10/25, why modified. */

 代码上传:

l  代码上传前，需要再次更新服务器上的代码，以防和服务器上的代码发生冲突。代码上传后，必须在第一时间口头或邮件通知组长或主管进行代码Review。如果Review未通过，被打回来后需要重新修改。

l  上传的注释(commit信息)必须写得清晰明了,格式如下:

[Subject]

[项目名：如S2] 提交的主题，关于什么的修改

[Defect/Enhancement/NewFeature]

是有什么影响，还是新功能，还是增强优化必须要写CSP号和remineBUG号！

[Problem]

是什么问题

[Solution]

怎么解决

[Project].

关于哪个项目

 

Warning：若不按此格式，将无法提交

有相关模版，如：

把commit_temp放在自己服务器根目录下：

然后在vi .gitconfig 添加下面内容：

[commit]

         template =/home/xxxx/commit_temp

注：xxxx就是自己用户名。