java-在Javadoc中哪个标签应该用作段落分隔符?

因此,根据最佳做法,哪个更合适的HTML标记可用于分解javadoc的段落/长节?

<p />还是<br />? 为什么?

Tom Tresansky asked 2020-08-01T16:16:30Z
3个解决方案
56 votes

欢迎来到HTML 3.2领域。

根据编写文档注释的官方指南,正确的段落分隔方法是使用段落标签:29923993722159114114。请看一下“文档注释格式”部分的第七个项目符号。

通常,我强烈建议您不要使用这种过时的,过时的做法进行标记。 但是,在这种情况下,有充分的理由例外。 JavaDoc工具(除非使用自定义Doclet进行彻底更新)会生成旧的,笨拙的,有点破损的标记。 浏览器被构建为与当今疯狂的旧标记向后兼容,因此您可以随心所欲地进行浏览。 您使用<P>分隔段落将与JavaDoc输出的其余部分保持一致。

Wesley answered 2020-08-01T16:16:56Z
30 votes

严格来说,自动关闭<p>是没有意义的,因为应该使用<br>来包含一个段落,即该段落应该用2992399872872948948和</p>括起来。

但是,<p>是一个“较低级别”标签,指示换行符。 因此,表示段落的语义正确方法是使用<br>

<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>会在行之间产生更多的空白,而<br>只会开始新的一行而不会引入任何主要的空白。

Joachim Sauer answered 2020-08-01T16:17:30Z
5 votes

使用Java 8,可以使用单个起始元素(</p>)。

请注意,javadoc不喜欢close元素(</p>)。

Jin Kwon answered 2020-08-01T16:17:54Z
translate from https://stackoverflow.com:/questions/5260368/which-tag-should-be-used-as-paragraph-separator-in-javadoc