documentation - 如何将换行符转换为标签（所见即所得）

Question

如何确保隐式换行符反映在输出 Javadoc 中，即换行符转换为<br/>标记？我觉得必须记住<br/>在我的评论的每一行添加标签很烦人。当然，如果没有<br/>标签，整个注释就会被压缩成一个不可读的块。

<br/>也许一个 doclet 只会用标签替换换行符？我google了很多，但没有想出任何东西。在开始编写自己的 doclet 之前，我想确保没有遗漏任何内容。

Answer 1

更好的是在您想要分节的地方插入一个<p>标签。在您想要换行的任何地方都放置换行符非常难看 - 当有人使用比您中断的窗口更宽或更窄的窗口时，这会很糟糕。

注意：如果您有想要包含在 JavaDoc 中的预格式化文本，那么您可以<pre>在此内容周围使用标签，您的文本不会被重新格式化为一个巨大的 blob。事实上，如果您想明确决定每个换行符的位置，您可以<pre>在整个 JavaDoc 周围使用该标记，尽管这是对该标记意图的滥用。