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

Question

根据最佳实践，哪个 HTML 标记更适合分解 javadoc 的段落/长部分？

是<p />或 <br /> ?为什么？

Answer 1

欢迎来到 HTML 3.2。

根据官方文档注释编写指南，正确的段落分隔方式是使用段落标签:<P> .查看 Format of a Doc Comment 部分中的第七个项目符号.

通常，我强烈建议不要使用这种陈旧过时的做法进行标记。但是，在这种情况下，有充分的理由异常(exception)。 Javadoc 工具(除非用自定义 Doclets 彻底更新)会生成旧的、粗糙的、有些损坏的标记。浏览器的构建是为了与当时疯狂的旧标记向后兼容，所以对你来说顺其自然是有意义的。您对 <P> 的使用分隔段落将与 Javadoc 输出的其余部分保持一致。