代码之家  ›  专栏  ›  技术社区  ›  Jonathan Day

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

  •  11
  • Jonathan Day  · 技术社区  · 14 年前

    我经常看到来自开发人员(大公司和个人)的生产代码,其中包含已被注释掉的代码。这可能会消除先前为了实现某些原因不起作用的功能而进行的尝试。

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

    是否有任何安全或最佳实践方面?

    3 回复  |  直到 14 年前
        1
  •  32
  •   Chuck    14 年前

    最佳实践是使用SCM。如果您认为旧代码确实是人们将来想要引用的代码,请留下一个“//我们以前用另一种方式来处理它,它有一个有趣的属性x——请参阅修订版103”,而不是留下一整块不做任何事情的代码。

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

    如果代码值得保留,那么它比在某个地方的注释中丢失更有价值。如果它不值得保存,就用火杀死它。

        2
  •  2
  •   sHr0oMaN    14 年前

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

        3
  •  1
  •   Zaz Volodymyr Null    14 年前

    最佳实践是您的代码只显示当前代码。您应该使用处理代码历史记录的SCM。