哪个标记应该用作Javadoc中的段落分隔符？

Question

根据最佳做法，哪个更合适的HTML标记用于分解javadoc的段落/长节？

是<p />还是<br />？为什么呢？

Answer 1

欢迎来到HTML 3.2。

根据撰写文档评论的官方指南，分隔段落的正确方法是使用段落标记：<P>。请查看Format of a Doc Comment部分中的第七个项目符号。

通常，我强烈建议不要使用旧的，过时的标记做法。但是，在这种情况下，有一个合理的理由来做出例外。 JavaDoc工具（除非使用自定义Doclet进行彻底更新）会生成旧的，苛刻的，有点破坏的标记。浏览器已经构建为与当时疯狂的旧标记向后兼容，因此您可以随意使用它。您使用<P>分隔段落将与JavaDoc输出的其余部分保持一致。

Answer 2

严格来说，自我关闭<p />毫无意义，因为<p>应该用于包含一个段落，即段落应该被{{1}包围}和<p>。

然而，

</p>是一个较低级别的＆＃34;表示换行符的标记。因此，表示段落的语义正确方式是使用<br>：

<p>

VS

<p>This Foo is used to frobincate a {@link Baz}.</p>
<p>It is quite groovy!</p>

视觉上This Foo is used to frobincate a {@link Baz}.<br> It is quite groovy! 会在行之间产生更多的空白，而<p>只会开始一个新行而不会引入任何主要的空白。

Answer 3

使用Java 8，单个起始元素（<p>）可以正常工作。

请注意，javadoc不喜欢结束元素（</p>）。