评论一段可能在将来有用的代码块是一个好习惯吗？

Question

对于可能在将来有用的代码块进行评论是一种好习惯吗？

1. 我的代码片段在我的企业应用程序中说了一个Java方法，可能会在近期或远期帮助我。
2. 我正在评论此方法，因为这在我目前的版本中暂时没用。
3. 这里我有一个很好的版本控制系统，如SVN。

那么什么是良好做法 - 使用SubVersion 或只是注释代码块并在需要时使用它？

Answer 1

评论代码具有数月和数年的生存趋势，而不会被取消评论。它也无意中出现在搜索中，并且可能误导其他碰巧看过它的人。

假设您正在使用源代码控制系统和错误跟踪器，请删除代码并输入“任务”或“错误”以重新实现该功能。

我不是在开玩笑。去掉它。我甚至看到了评论踩到评论的错误，并且由于嵌套，一些代码变得没有注释！

最佳做法是依靠subversion或git或其他一些源代码控制系统。评论代码就像在每张纸上贴一张便条，你应该忽略它坐在桌子上（而不是从桌面上取下）。最终桌子上的纸张太多了，不重要。您的源代码太宝贵了，不值得使用不重要的代码。

Answer 2

（我认为这个问题最好在程序员页面下进行讨论）

老实说，这取决于。如果你知道某些代码是真的很有用那么并且将来编写它并不是一件容易的事情，我认为没有理由你不应该保留它。但是，关键是你应该有足够的评论让其他人知道为什么有一段代码片段被注释掉并留在源代码中。

我的建议是，如有疑问，请不要保留。只有在你知道自己应该做的时候才能保留这类代码。

Answer 3

我不会对此代码进行评论，但请将其删除。

• 评论代码会有点腐烂，在您删除评论并试一试之前，您不会再注意到它不再有效。
• 其他开发人员可能会觉得为什么会有您的评论代码。它是否被评论用于测试并且忘记取消评论？应该删除吗？
• 我会使用Subversion等。您可以提及删除该方法。然后，您可以轻松找到提交并从那里获取代码。