为什么在每个 JavaDoc 行上都有一个星号前缀?

ali*_*ind 4 java javadoc

在 JavaDoc 块中的每一行之前放置星号的原因是什么?虽然这似乎是鼓励和接受的约定,而且我终于屈服于这样做,但它肯定不会使我的文档编写速度更快(尽管有助于创建它们的工具,例如Sublime 中的DocBlockr 插件) .

多行注释中的行不超过 75 个字符的一个明显好处是,您的代码可以更轻松地共享,而无需对其进行调整,并且查看者无需向右滚动即可阅读您的文档。

但是为什么要更进一步,并有这个额外的约定呢?左侧的填充空间可以使用可选的星号前缀来完成......为什么每一行?

Jen*_*der 5

我没有任何证据可以证明这一点,但我总是将其归因于那个时代,当时世界上的一切事物实际上都是黑色或白色(即黑色或绿色)。在那个时候,您无法轻松区分代码和注释。

那些星号前缀使得识别文件部分变得非常容易,您可以放心地忽略这些部分。


Ste*_*n C 5

这是一种风格约定……尽管 javadoc 命令确实(显然)在某些情况下以不同的方式对待引导*和不引导的*情况。

的Sun Java风格指南描述在5.2节的惯例。

为什么?好吧,真正的答案只能由开发 Java 风格指南的人提供。

但是,我的猜测是他们认为这会使 javadoc 注释更加突出。


可以使用可选的星号前缀来填充左侧的空格。

嗯……这可选的。您不需要遵循约定,除非您的项目的样式指南要求您这样做。

很高兴知道为什么我必须在我曾经和将要编写的每一行文档上多花一三个按键。

询问开发您正在使用的 IDE 的人:-)