在Javadoc中,哪个标记应该用作段落分隔符?

在Javadoc中,哪个标记应该用作段落分隔符?,java,comments,javadoc,Java,Comments,Javadoc,根据最佳实践,哪种HTML标记更适合拆分javadoc的段落/长节 是还是?为什么?严格来说,自动关闭的没有任何意义,因为应该用于包含段落,即段落应该由和包围 然而,它是一个表示换行的“较低级别”标记。因此,从语义上来说,指示段落的正确方法是使用: 此Foo用于将{@link Baz}折叠起来 真是太棒了 vs 此Foo用于将{@link Baz}折叠。 真是太棒了! 从视觉上看,会在行之间产生更多的空白,而只会开始一个新行,不会引入任何主要的空白。欢迎来到HTML 3.2的国度 根据官方的

根据最佳实践,哪种HTML标记更适合拆分javadoc的段落/长节


还是

?为什么?

严格来说,自动关闭的

没有任何意义,因为
应该用于包含段落,即段落应该由
包围


然而,它是一个表示换行的“较低级别”标记。因此,从语义上来说,指示段落的正确方法是使用

此Foo用于将{@link Baz}折叠起来

真是太棒了

vs

此Foo用于将{@link Baz}折叠。
真是太棒了!

从视觉上看,
会在行之间产生更多的空白,而

只会开始一个新行,不会引入任何主要的空白。

欢迎来到HTML 3.2的国度

根据官方的文档评论撰写指南,正确的段落分隔方式是使用段落标签:
。看一看关于的部分中的第七个项目符号


通常,我强烈建议不要在标记中使用这种过时的旧做法。然而,在这种情况下,有一个合理的理由可以破例。Javadoc工具(除非使用自定义doclet进行彻底更新)生成旧的、粗糙的、有点破损的标记。浏览器是为了向后兼容当今疯狂的旧标记而构建的,因此,您只需遵循它就可以了。使用

分隔段落将与Javadoc输出的其余部分保持一致。

对于Java8,一个单一的起始元素(

)可以工作


请注意,javadoc不喜欢结束元素(

)。

取决于您对“nice”的定义。为什么不在浏览器中同时尝试并检查两者的差异呢?嗯,我想“很好地显示”是指“遵循最佳实践”。虽然它似乎违反了HTML语义,但在您找到的文档中似乎非常清楚。它不违反HTML语义,它只违反了xhtml语义。@Wesley:应该链接到使用
的文档,小写为p。也许自从你发布答案后,它已经更新了。我认为你也应该更新你的答案@Lii当引用HTML3.x元素时,它们在所有大写字母中指定,如

。当提到文档中的实际文本(无论是.html还是Javadoc)时,如果您愿意,您可以将文本编写为
。不幸的是,JDK8禁止自动关闭
,还有什么替代方法?@eckes,您是否可以参考JDK8禁止自动关闭
的位置?@HonzaZidek,您可能知道,JDK8中对JavaDoc的更改非常深远和严格,但没有很好的文档记录。我的“取缔”指的是我观察到的使用它将导致构建中止失败,只要您不抑制它:
[ERROR]……java:24:ERROR:self-closing-element-not-allowed[ERROR]*实例。
。我想解决方法是使用HTML
(就像我习惯使用作为段落分隔符而不是块级别)。@eckes:我不知道JDK8中对JavaDoc的更改,如果你能给我指一篇文章、文档或任何描述它的东西,我将不胜感激。这对HTML来说是一个很好的建议,但对Javadocs来说却是一个很糟糕的建议
javadoc
不能很好地使用这些现代最佳实践,新版本对接受这样的标记更为严格。但为什么?!我已经在代码中看到了它,这就是为什么我要阅读关于这个问题的答案-有人离开了
而没有
,这对其他人来说没什么问题,但对我来说不是://参见HTML 3.2。“end标记是可选的,因为它总是可以被解析器推断出来。”这是一种非常非常古老的做法,过去很多人认为它看起来很好<代码>

在网络上并不常见。