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

标签 java javadoc

背后的原因是什么putting an asterisk before JavaDoc block 中的每一行?虽然这似乎是受到鼓励和接受的惯例,而且我最终屈服于这样做,但它肯定不会让我的文档编写变得更快(尽管有帮助创建它们的工具,例如作为 Sublime 中的 DocBlockr plugin

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

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

最佳答案

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

Sun Java Style Guidelines在 5.2 节中描述约定。

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

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


Padding spaces to the left side could be done with an optional asterisk prefix..

呃……它可选的。您不必遵守约定,除非您的项目的样式指南要求您遵守。

It would nice to know why I have to spend an extra keypress or three on every single line of documentation I have ever and will ever write.

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

关于java - 为什么在每一行 JavaDoc 上都有星号前缀?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/29281055/

相关文章:

java - HTML重定向

maven - 如何从Maven站点中的Test JavaDoc链接源类JavaDoc?

java - Javadoc 报告生成中发生错误 - 未知标签

java - @WebServlet 注释似乎会干扰 javadoc。有一个简单的解决方法吗?

java - 将复选框样式更改为 Cross - Android

java - 循环java中Rnd Num的平均值

java - 使用 JDateChooser 从数据库检索数据?

java - 在运行时暂停 Groovy 脚本

android - setContentView(R.layout.Main); Main 无法解析或不是字段

java - 使用Java的swagger自动生成其余端点