用于历史目的的注释代码的替代方案

Tic*_*cie 11 version-control comments codebase

有没有人有一个有效的替代方案,使用已注册的代码进入存储库以查找可查找性?

我问的原因是因为我最近与一位开发人员讨论过检查注释掉的代码.我的立场是,注释掉的代码永远不应该被检查到我们的VCS中,因为它在技术上不是代码库的一部分,因此令人烦恼的事情并不值得它占用的字节,可以这么说.

他的反对意见是,他检查过的一些注释掉的代码仍然说明了他希望将来修复的一些工作(在这一特定点上,评论发生在2年前,但除了这一点之外).他希望将它保留在代码库中,以便他可以轻松找到它,即使它目前无法编译,它仍然在全局范围内显示解决它的正确方法.

最后,他同意了,注释掉的代码不属于.但是当我们想到他可能的替代品时,我们的确很短.

我能想到的唯一选择是:

  • 维基:只需将其粘贴到维基上.这样做的缺点是它会与其他非代码相关的wiki内容混在一起,这可能会使搜索很难.
  • 索引所有VCS版本:这对我来说很大程度上是理论上的,但有哪些系统可以使代码库及其整个历史记录可搜索?

有没有人知道/使用任何替代品?我的两个选项听起来都比实际值得多,但这可能会因我的推理而倾斜,因为无论如何注释掉代码都是毫无价值的.我讨厌必须去"嘿,如果你现在没有时间来解决这个问题并不重要,无论如何都要留在代码库中"路线(但如果没有可行的替代方案,我会这么做).

对不起这个可怕的头衔,我无法想出一个更好的头衔

kro*_*ock 1

听起来你的朋友应该创建一个分支并在那里尝试他的“改进”。您可以轻松区分此改进分支和当前源代码,以清楚地表示他打算进行的更改。