如何让 IntelliJ 打破 </p> 上的 javadoc 行答案

【问题标题】：How to make IntelliJ to break javadoc lines on </p>如何让 IntelliJ 打破 </p> 上的 javadoc 行
【发布时间】：2015-09-20 06:11:00
【问题描述】：

我使用</p> 标记在Javadoc 中换行。它既老式又在 Elcipse 工作。不幸的是，它在 IntelliJ 中不起作用：

如您所见，“to javadoc”和“This is it”之间没有换行。

同时，Eclipse 工作正常：

代码如下（不考虑图片路径——来自其他测试）：

package tests.helloworld;

/**
 * This is try to javadoc</p>
 * This is it
 * <img src="/myimage.jpg">
 */
public class Runner {
    public static void main(String[] args) {
        System.out.println("Hello world");
    }
}

更新

当然生成的javadoc在浏览器中是可以的：

【问题讨论】：

您是否尝试在您的 Javadoc 中使用正确的 HTML（即用 <p> 开始标签和将 </p> 结束标签包围“This is try to javadoc”） ?
我希望使用单个结束标记，因为它可以节省输入。它在除IntelliJ 之外的任何地方都有效。
在这种情况下，您应该只在段落之间使用单个 <p> 标签，而不是在段落之后使用单个 </p> 标签 (random source) 或使用 <br> 标签 (other source) .
确实如此。然而，正如我所说，简单地用<p> 标签分隔段落是常规的。
你从哪里得到</p> 语法？如果您真的不想使用格式良好的 HTML，至少对自闭合元素使用正确的语法：<p/>。这在 IntelliJ IDEA 中有效，它不会自动添加开始标签。

标签： java intellij-idea javadoc

【解决方案1】：

虽然<p> [...] </p> 格式可能更简洁/易于理解，但如果您只是想要换行符，您可以使用<br>：

/**
 * This is try to javadoc<br>
 * This is it
 * <img src="/myimage.jpg">
 */

示例：

【讨论】：

由于某种原因，</br> 无法与 IntelliJ 一起使用。只需 <br> 即可。
好吧，</br> 在任何情况下都无效。但是，如果您的意思是 <br />，那与 <br> 一样有效。

【解决方案2】：

您需要使用<p> 而不是</p>。 HTML 中需要开始标记，而在某些情况下可以省略结束 </p> 标记。

见https://developer.mozilla.org/en-US/docs/Web/HTML/Element/p:

开始标签是必需的。如果<p> 可以省略结束标记元素后紧跟<address>、<article>、 <aside>, <blockquote>, <div>, <dl>, <fieldset>, <footer>, <form>, <h1>, <h2>, <h3>, <h4>, <h5>, <h6>, <header>, <hr>, <menu>, <nav>, <ol>, <pre>, <section>, <table>, <ul> 或另一个 <p> 元素，或者如果在父元素且父元素不是<a> 元素。

在 Javadoc 中，通常要么有另一个 <p> 标记，要么父元素中没有更多内容，所以这是可行的。

【讨论】：

【解决方案3】：

注意：如果您使用 Kotlin 搜索 JavaDoc：

在 IntelliJ IDEA 2020 上，<p></p> 和 <br> 都不适用于 Kotlin，只有一个空行。
更值得一提的是，<p></p> 中的语句根本不显示。

KDoc Documentation

【讨论】：