我如何使用“<”和“>”在javadoc中没有格式化？

Question

如果我在 javadoc 中编写 ，它不会出现，因为标签在格式化文本方面具有特殊功能。

如何在 javadoc 中显示这些字符？

Answer 1

一个完整的示例展示了使用 {@code }、{@literal } 以及转义来保留 < 和 > 。 。

package example;

public class Example {

    /**
     * Prints the perfect XML.
     * 
     * The following XML will be printed:
     * 
     *
     * <pre>{@code
<hello>
    <world>
        <value>42</value>
        <value>
           * oops?
        </value>
    </world>
</hello>
     * }</pre>
     * 
     * 
     * Keep leading stars if you want. Will still be ignored.
     * 
     * <pre>{@code
     * <hello>
     *     <world>
     *         <value>42</value>
     *         <value>
     *            * oops?
     *         </value>
     *     </world>
     * </hello>
     * }</pre>
     * 
     * Look at stdout.
     */
    public void printXML() {
    }

    /**
     * Prints meanings of {@code Map<String, Integer>}.
     * 
     * {@code Map<String, Integer>} can represent:
     * <ul>
     * <li>{@literal Map<Input, Hash>}</li>
     * <li>{@literal Map<Team, Score>}</li>
     * <li>{@literal Map<Country, GDP>}</li>
     * </ul>
     * 
     * Look at stdout.
     */
    public void printMapRelations() {
    }

    /**
     * {@literal 
     * Proves 4 < 2 + 3 is the same as 2 + 3 > 4
     * 
     * No markup is required to show that flipping the left and right sides 
     * of an < expression causes < to become >.
     * 
     * Don't use <and> carelessly.
     * }
     */
    public void printProof() {
    }

    /**
     * Javadoc is HTML so encoded <strong><</strong> and <em>></em> work but
     * not super
     * legible in source.
     */
    public void printOther() {
    }
}

注意：IDE 预览和实际输出有时看起来略有不同。

提醒：./gradlew javadoc 默认情况下会构建到 build/docs/javadoc/。

另请参阅：

• https://docs.oracle .com/javase/7/docs/technotes/tools/windows/javadoc.html#javadoctags（此页面的当前版本是什么？）

Answer 2

您可以使用 < 表示 < ，使用 > 表示 > 。

Answer 3

最新版本的 JavaDoc 支持 {@literal AC}；这会正确输出内容（转义生成的 HTML 中的“<”和“>”）。

请参阅http://download.oracle.com/javase/1.5 .0/docs/guide/javadoc/whatsnew-1.5.0.html

Answer 4

考虑到 XML 是实际代码，我相信 Javadoc 中的 XML 片段更适合 {@code AC} 标记，而不是 {@literal AC} 标记。

{@code } 标签使用固定宽度的字体，使其内容与实际代码一样突出。

Answer 5

将它们转义为 HTML：< 和 >

Answer 6

插入

 {@code} 在 javadocs 中保存尖括号和空行，并且被广泛使用，例如，参见 java.util.Stream。

<pre>{@code
   A<B>C

   D<E>F
}</pre>

Answer 7

您只需使用尖括号之一的 HTML 等效项即可。 < 可以表示为 < 或 <。这是取自真实 Javadoc 的示例：

<pre>
<complexType>
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
      [...]

显示为：

<complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>

Answer 8

只需用 {@code} 包围它，如下所示：

{@code <xmlElement>}

Answer 9

如果你设置maven使用markdown，你可以用反引号将其括起来。

`AC` 读起来比 {@code AC} 好一点

Answer 10

就我而言，我想放入 javadocs List...

我通过提供指向我的 SomeClass 的链接添加了更具体的信息，所以这里是我的解决方案：

List<{@link SomeClass}>

这导致了一个干净的结果：

List<SomeClass>

带有下划线的“SomeClass”指向指定的类。

（当然，如果SomeClass不在同一个包中，则应引用完整路径）