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

Jon*_*Day 13 comments coding-style release

我经常看到开发人员(大公司和个人)的生产代码,其中包含已被注释掉的代码.据推测,这可以消除早期尝试实现由于某种原因无效的功能.

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

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

Chu*_*uck 36

最佳做法是使用SCM.如果您认为旧代码确实是人们将来想要引用的内容,请留下评论"//我们曾经以另一种方式执行此操作,其中包含有趣的属性X - 请参阅修订版103"而不是留下整个块没有做任何事情的代码.

评论代码有它的位置,但那个地方是快速测试,甚至不值得花时间做分支.

如果代码值得保留,那么它比在某个地方的评论中丢失更有价值.如果不值得保留,请用火将其杀死.

  • 我喜欢包含引用特定修订的评论的想法。 (2认同)
  • 投票赞成“用火杀死它”:D (2认同)

sHr*_*MaN 5

代码应存储在源代码管理中。
应保留注释来解释难以理解的代码或执行不寻常操作的原因。