问如何区分注释代码和文档注释

EN

不要将注释标记为注释，如果在文件中工作时发现已注释掉的代码，只需删除它。另外，尝试让那些仍然坚持注释掉代码的人停止这样做，除非你能阻止人们注释掉坏代码块，而不仅仅是删除它们，否则什么都不会改变。然后，这只是一个简单的问题，您的团队一起工作，以消除注释的代码，当他们发现它，试图让那些留下注释的代码回去，并清理它只是一个食谱，不必要的戏剧。

要小心，因为文档注释有时也包含代码示例。你想留着那些。例如：

/**
  * This class does something.
  * Usage:
  * <code>
  * MyClass.doSomething();
  * </code>
  */

可能没有防止错误的方法，但是您可以编写一个简短的Perl脚本，该脚本可以查找代码中的所有注释，保留文档注释，然后使用一些正则表达式来猜测注释的开头部分。

我认为@Ryathal提出的“一看即核”的策略是正确的。

如果您想检测注释掉的代码(请不要称之为“注释代码”，因为很多人认为这意味着注释代码！)然后，我认为您需要通过检查后续版本之间的差异来做到这一点。即使这样，它也不是直截了当的，因为有各种各样的方法可以注释掉代码.取决于编程语言。