为什么'//‘风格的多行注释不好(在Java中)？

Question

http://java.sun.com/docs/codeconv/html/CodeConventions.doc4.html#286

我读了Java编码惯例的上面一节，开始怀疑为什么上面写着"//注释.不应该在连续的多行文本注释中使用“

为方便起见，请将有关部分粘贴于此：

//注释分隔符可以注释掉一行完整的行，也可以注释掉部分行。它不应该用于连续的多行文本注释；但是，它可以在连续的多行中用于注释代码的各个部分。

这有什么合理的理由吗？

Answer 1

这样做的想法是，多行文本注释是一个实体--您希望在逻辑上将它保持在一起。在这样的评论中，换行符只不过是包装文本的地方，因此将其分解成许多“单独”的注释是没有意义的。因此，可以围绕整个过程构建一个单独的注释块--使用/* */。

对于注释掉的代码，每一行都是自己的逻辑单元，所以使用连续的“//”是可以的--有时也可以。如果个别行由于某种原因可以被注释回"in“，但不是所有的行，则尤其如此。虽然如果您想注释掉一个完整的块代码，在其中部分注释它/退出是没有意义的，但是您可能仍然倾向于使用/* */ -再次将所有内容逻辑地和可视化地组合在一起。

Answer 2

它使修改和格式化长注释非常痛苦。

大多数编辑器提供了某种包装功能，可以自动将文本包装成可读长度的行。如果每一行都以'//‘开头，则必须删除这些行，并重新插入新行。使用'/* */样式注释可以避免所有这些繁琐的工作。

Answer 3

即使用//注释大量的代码有时也会非常可怕。

我使用日食，虽然我真的很享受日常编程带来的苦差事，但是有一些特性组合会产生奇怪的结果……例如..。

选择已经包含一些//多行注释掉代码的大型代码块，按ctrl-/并将其全部注释掉，然后执行ctrl f来格式化您的代码，如果由于某种原因，格式化程序处理注释将重新格式化您的代码。然后重新选择整件事，再用ctrl-/取消注释.

一些格式选项只会绕过注释的代码和中继--当您取消注释时，所有的内容都会中断，您将不得不解析它并手动重新格式化它。

我承认这是一件轶事，我已经重新配置了eclipse，不再这样做了，但是现在我也不再使用//来支持/* */这样大的代码注释条。然而，还有许多其他更好的选择：

用于Javadoc注释的/** */这样的注释可以在代码完整、文档等中访问.评论一次，随时随地使用。

如果您知道要创建不是java的多行注释，那么使用/*启动它，在格式化过程中，它将处理其余的部分。因此，为了解释代码中奇怪的修补算法，我将使用/* */而不是//。必要的时候，我把它放在单人班轮上。

我的2美分