您是否对代码中的错误修复使用了特殊注释？

我的一些同事对其错误修复使用了特殊评论,例如:

// 2008-09-23 John Doe - bug 12345
// 

这有意义吗？
您是否以特殊方式评论错误修复？

请告诉我.

我没有这样的评论,源控制系统已经维护了历史记录,我已经能够记录文件的历史记录了.

我确实提出了一些评论,这些评论描述了为什么一些非显而易见的事情.因此,如果错误修复使代码不那么可预测和清晰,那么我解释原因.

随着时间的推移,这些可能会累积并增加混乱.最好使代码清晰,为可能不明显的相关问题添加任何注释,并将错误细节保留在跟踪系统和存储库中.

我倾向于不在实际来源中发表评论,因为它可能很难保持最新.但是我确实在源代码管理日志和问题跟踪器中添加了链接注释.例如我可能在Perforce中做这样的事情:

[Bug-Id] xyz对话框问题.将大小调整代码移动到abc,现在稍后进行初始化.

然后在我的问题跟踪器中,我将执行以下操作:

已在changelist 1234中修复.

将大小调整代码移动到abc,现在稍后进行初始化.

因为那时留下了一个很好的历史标记.如果您想知道特定代码行是以某种方式存在的原因,您也可以轻松查看文件历史记录.找到代码行后,您可以阅读我的提交注释,并清楚地看到它的错误以及我如何修复它.