代码注释及代码提交规范
来源:互联网 发布:知乎 大误 编辑:程序博客网 时间:2024/06/08 19:34
修改代码必须按照以下格式进行注释
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就是自己用户名。
- 代码注释及代码提交规范
- Javascript代码及注释规范
- C#代码注释规范及文档生成
- 代码注释规范[转]
- Java代码注释规范
- C# 代码注释规范
- 代码注释规范
- 代码注释规范(1)
- 代码注释规范(2)
- 代码注释规范(3)
- C# 代码注释规范
- JAVA代码注释规范
- 代码添加注释规范
- java代码注释规范
- js代码注释规范
- 代码中的注释规范
- C++代码注释规范
- java代码注释规范
- Qt学习笔记4
- 第四部分 个人理财风险防范8.当心银行汇款引发的诈骗
- tomcat java 内存
- ExtJS panel展开时加载数据或页面
- 表变量
- 代码注释及代码提交规范
- tomcat免安装和安装版区别以及分别的安装步骤
- How to create a Windows can run top of Metro UI under windows8c
- IT术语
- hdu 1009
- 2013年3月博客行业网站综合影响力排名
- js的Prototype属性 解释及常用方法
- java.lang.IllegalStateException: BeanFactory not initialized or already closed - call 'refresh' bef
- Swap the elements of two sequences, such that the difference of the element-sums gets minimal.