版本控制注释的最佳做法 [英] Best practices for version control comments

问题描述

有很多关于评论代码的对话，但如何评论签到？

There is a lot of conversation about commenting code, but how about commenting on check-ins?

我发现这篇博文：
http://redbitbluebit.com/subversion-check-in-comment-great-practices/

I found this blog post: http://redbitbluebit.com/subversion-check-in-comment-great-practices/

作为整理发布说明的人，我正在寻找方法让这项工作更容易。

As the guy who is putting together the release notes, I am looking for ways to make that job easier.

目前，我们为应该发布给我们的软件客户的任何内容定义了< Begin_Doc> ...< End_Doc>

Currently we defined our own scheme with <Begin_Doc>...<End_Doc> for anything that should be published to our software customers. But even for the internal stuff, I'd like to know the "why" for every change.

推荐答案

每个功能都有一个ticket / issue / bugreport / task / whatever-you-call-it，票证号总是在签入注释中引用。这提供了上下文。

Every feature has a ticket/issue/bugreport/task/whatever-you-call-it, and the ticket number is always referenced in the check-in comment. This gives context.

这篇关于版本控制注释的最佳做法的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！