version-control - checkin "commented out"代码

Question

关闭。这个问题是opinion-based .它目前不接受答案。












想改进这个问题？更新问题，以便 editing this post 可以用事实和引用来回答它.

4年前关闭。




Improve this question




好的，这在我目前的工作中引起了一些摩擦，我真的没想到会这样。组织内部软件开发在这里是一个新概念，我已经起草了一些编码指南的初稿。

我建议永远不要将“注释掉”的代码 checkin 存储库。我这么说的原因是存储库维护了文件的完整历史记录。如果您要删除功能代码，则将其完全删除。存储库保留您的更改，因此很容易查看更改的内容。

这引起了一些摩擦，因为另一位开发人员认为采用这条路线过于严格。该开发人员希望能够注释掉一些他正在处理但不完整的代码。然后，此代码将永远不会被 checkin ，然后不会保存在任何地方。我们将使用 TFS，所以我建议搁置更改将是最正确的解决方案。然而，它没有被接受，因为他希望能够 checkin 可能会或可能不会部署的部分更改。

我们希望最终能够充分利用持续集成并自动部署到开发 Web 服务器。目前没有 Web 服务器或数据库服务器的开发版本，但很快就会改变。

无论如何，你的想法是什么？您认为“注释掉”的代码在存储库中有用吗？

我很想听听其他人关于这个话题的意见。

编辑:
为清楚起见，我们不使用私有(private)分支。如果我们这样做了，那么我会说用你的私有(private)分支做你想做的事，但永远不要将注释掉的代码与主干或任何共享分支合并。

编辑:
我们没有正当理由不使用私有(private)或每用户分支。这不是我不同意的概念。我们只是还没有这样设置。也许这就是最终的中间立场。现在我们使用 TFS 搁置。

Answer 1

我留下注释掉代码的一种情况:

// This approach doesn't work
// Blah, blah, blah

当这是解决问题的明显方法时，它包含一些微妙的缺陷。当然，存储库会拥有它，但存储库不会在 future 警告任何人不要走那条路。