在生产版本中留下注释掉的代码是不好的做法答案

【问题标题】：Is it bad practice to leave commented-out code in production releases在生产版本中留下注释掉的代码是不好的做法
【发布时间】：2011-04-09 12:31:17
【问题描述】：

我经常看到来自开发人员（大公司和个人）的生产代码，其中包含已被注释掉的代码。据推测，这消除了早期尝试实现由于某种原因不起作用的功能。

在我看来，这很混乱，但可能有一些好处，例如在返回重构或扩展代码时，开发人员可以看到之前尝试过的内容。

这有什么安全性或最佳实践方面吗？

【问题讨论】：

【解决方案1】：

最佳做法是使用 SCM。如果您认为旧代码确实是人们将来想要参考的东西，请留下评论“//我们曾经以另一种方式进行，它具有有趣的属性 X——参见修订版 103”，而不是留下整个块不做任何事情的代码。

注释掉代码有它的位置，但那个位置是快速测试，甚至不值得花时间做一个分支。

如果代码值得保留，那么它比在某处的评论中丢失更有价值。如果不值得保留，就用火将其杀死。

【讨论】：

我喜欢包含引用特定修订的评论的想法。
如果 (1) 使用嵌入式系统编译器，它不会优化未使用的方法，并且 (2) 有一系列类似的函数（例如 put (signed/unsigned)( byte/word/long))，其中一些碰巧正在使用，而另一些则没有。让正交函数集随时可用似乎是可取的，即使有些函数被#if'ed out 以节省目标上的 ROM 空间。
@supercat：如果它在 SCM 中，它就像#if'd out 一样可用。
今天我一直在从代码库中删除注释掉的代码。迄今为止，我发现的最古老的注释代码的记录是 17 年。我的 git 提交消息应该是金色的。幸运的是，我有这个答案可供参考。

【解决方案2】：

代码应存储在源代码管理中。
注释应该保留，以解释难以理解的代码或做一些不寻常的事情的原因。

【讨论】：

【解决方案3】：

最佳做法是您的代码只显示当前的。您应该使用处理代码历史的 SCM。

【讨论】：