【代码审查系列6】GIT修改注释模板方式

在使用Git做版本控制工具的团队协助开发中,保证团队成员在提交代码后能够更详尽的追溯源头下。规范代码注释的必要性就得以体现。通过制定这种规范约束,可以显著提高代码提交的目的可追溯性。这里介绍Git修改注释模板方式。

创建过程

  1. git命令下创建注释模板

创建 XX_template文件,内容为团队制定的git提交规范例如:

1
2
3
Desgraption: 
Date:
Author:

通过git config配置commit_template,如下:

1
git config –-global commit.template /d/develop/Git/Git_Home/commit_template

设置git commit时填写注释所用的编辑器,如下:

1
git config --global core.editor vim

设置后,提交试用git commit