首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >签入“注释掉”的代码

签入“注释掉”的代码
EN

Stack Overflow用户
提问于 2009-04-16 22:24:07
回答 19查看 15.7K关注 0票数 96

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

我建议永远不要将“注释掉”的代码签入到存储库中。我之所以这样说,是因为存储库维护着文件的完整历史记录。如果您要删除函数代码,则将其完全删除。存储库保留了您的更改,因此很容易看到更改了哪些内容。

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

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

不管怎样,你的想法是什么?你认为“注释掉”的代码在存储库中有用吗?

我很有兴趣听到其他人对这个话题的看法。

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

编辑:我们没有合理的理由不使用私有或每用户分支。这不是一个我不同意的概念。我们只是还没有这样设置它。也许这就是最终的折衷方案。现在我们使用TFS搁置。

EN

回答 19

Stack Overflow用户

发布于 2009-04-17 01:02:54

有一个例子,我把代码注释掉了:

代码语言:javascript
复制
// This approach doesn't work
// Blah, blah, blah

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

票数 27
EN

Stack Overflow用户

发布于 2009-04-16 22:55:38

当你需要添加一个小功能或者像现在这样的bug修复时,在接下来的3分钟内,你必须修复一个你已经开发了一半代码的文件,我会说这是好的,实际需求在战场上凌驾于实用理想之上。

票数 7
EN

Stack Overflow用户

发布于 2009-04-16 22:32:01

我大体上同意注释掉的代码不应该签入的原则。源代码控制系统是一个共享资源,在某种程度上,您的同事将其用作他的个人便签簿。这对其他用户来说并不是很体贴,特别是如果您赞同代码库的共享所有权的想法。

下一个看到被注释掉的代码的开发人员不会知道这是一个正在进行的工作。他可以随意更改吗?它是死代码吗?他不知道。

如果你的同事的变更没有处于可以签入的状态,他需要完成它,和/或学习进行较小的增量更改。

“签入可能部署或不部署的部分更改”--想必这也意味着可能会或可能不会进行测试?对于一个非常糟糕的代码库来说,这是一个滑坡路。

票数 6
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/758279

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档