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

2022-08-31 20:30:59

根据最佳实践,哪个是更适合分解javadoc的段落/长部分的HTML标签?

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


答案 1

欢迎来到 HTML 3.2 的国度。

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

通常,我强烈建议不要使用这种旧的,过时的标记实践。但是,在这种情况下,有一个不错的理由破例。Javadoc工具(除非使用自定义Doclet进行彻底更新)会生成旧的,粗糙的,有些损坏的标记。浏览器已经构建为与当时疯狂的旧标记向后兼容,因此您只需配合它即可。您使用分隔段落将与 Javadoc 输出的其余部分保持一致。<P>


答案 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!

从视觉上看,结果是行与行之间有更多的空白,而a将只开始一个新行,而不会引入任何主要的空白。<p><br>


推荐