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

Question

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

难道<p /> 还是<br />？为什么？

Answer 1

欢迎来到HTML 3.2的土地.

根据撰写文档评论的官方指南,分隔段落的正确方法是使用段落标记:<P>.请查看文档注释格式一节中的第七个项目符号.

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

Answer 2

严格来说,自我封闭<p />是没有意义的,因为<p>应该用来包含一个段落,即段落应该用<p>和包围</p>.

<br>但是是一个"低级"标记,表示换行符.因此,指示段落的语义正确方式将是使用<p>:

<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>结果是行之间有更多的空白,而a <br>只会开始一个新的行并且不会引入任何主要的空白.

Answer 3

在Java 8中，单个起始element（<p>）起作用。

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