修复 Java 8 的 Javadoc 错误答案

【问题标题】：Fixing Javadoc Errors for Java 8修复 Java 8 的 Javadoc 错误
【发布时间】：2017-01-10 07:41:25
【问题描述】：

我正在尝试将现有应用程序的 javadocs 编辑为与 Java-8 兼容。我不想跳过检查错误。我想修复它们。我对 HTML 标签感到困惑，即：

<code></code>
<ul></ul>
<li></li>
<ol></ol>

我知道我可以将@code 用于<code></code> 等，但是有很多HTML 标签，根据javadoc 是不允许的。我试图逃避它们，即：

&lt;code&gt;&lt;/code&gt;
&lt;ul&gt;&lt;/ul&gt;
&lt;li&gt;&lt;/li&gt;
&lt;ol&gt;&lt;/ol&gt;

但是，它们像往常一样在 Javadoc 中打印为文本，而不是 HTML 标记。我可以看到它在Javadoc的相应位置写了<code></code>。

如何在 Java 8 中修复 Javadoc 的此类错误？

【问题讨论】：

那么，导致错误的代码是什么，错误是什么？
为什么您认为不能在 Java 8 的 javadoc 中使用 HTML 标签？ Java 8 的javadoc manual 表示您可以： 文本必须用 HTML 编写，带有 HTML 实体和 HTML 标记 [...] HTML 4.0 是首选 [...] 小于符号 () 应写为 <和>。同样，与号 (&) 应写为 &
您在哪里发现不允许使用 HTML 标记？人们争论这样做是否是一个好idea；但从技术上讲，这很好用。我们的团队同意 HTML 标签；所以我们的 javadoc 有很多；所有这些都很好。不使用它们的唯一原因是“约定俗成”。
好吧，如果您转义 HTML 标记，它们将被打印为文本。这不应该让你感到惊讶。你期待什么？

【解决方案1】：

Javadoc 在 Java 8 中检查有效的 HTML。因此，您无需转义任何内容，只需遵守有效 HTML 样式的规则即可。

【讨论】：