在javadoc注释中包含特定的代码示例时，我遇到了很大的困难。我想分享这个。 请注意以下事项:

使用旧的<code> -标签来防止花括号被解释 new {@code…} -标签来获取输出中包含的泛型 @Override中的@符号通过"{@literal @}Override"转义，因为javadoc生成器在那里“倾斜”，因为@直接放在左花括号后面 在{@code和{@literal前面删除一个空格，以补偿内部空格并保持对齐

javadoc代码:

/** this methods adds a specific translator from one type to another type. `
  * i.e.
  * <pre>
  * <code>new BeanTranslator.Builder()
  *   .translate(
  *     new{@code Translator<String, Integer>}(String.class, Integer.class){
  *      {@literal @}Override
  *       public Integer translate(String instance) {
  *         return Integer.valueOf(instance);
  *       }})
  *   .build();
  * </code>
  * </pre>
  * @param translator
  */

被打印为

new BeanTranslator.Builder()
  .translate(
    new Translator<String, Integer>(String.class, Integer.class){
      @Override
      public Integer translate(String instance) {
        return Integer.valueOf(instance);
      }})
  .build();

至少在Visual Studio Code中，你可以通过将Javadoc注释包装成三反引号来强制它遵守换行符，如下所示:

/** ```markdown
 * This content is rendered in (partial) markdown.
 * 
 * For example, *italic* and **bold** text works, but [links](https://www.google.com) do not.
 * Bonus: it keeps single line-breaks, as seen between this line and the previous.
 ``` */

我能够用下面的代码片段生成好看的HTML文件——代码1中显示了它。

 * <pre>
 * {@code
 * A-->B
 *  \
 *   C-->D
 *    \   \
 *     G   E-->F
 * }
 *</pre>

(代码1)

如图1所示，代码1变成了生成的javadoc HTML页面。

A-->B
 \
  C-->D
   \   \
    G   E-->F

(图1)

然而，在NetBeans 7.2中，如果你按Alt+Shift+F(重新格式化当前文件)，代码1就会变成代码2。

 * <
 * pre>
 * {@code
 * A-->B
 *  \
 *   C-->D
 *    \   \
 *     G   E-->F
 * }
 * </pre>

(代码2)

第一个<pre>现在被分成两行。代码2生成生成的javadoc HTML文件，如图2所示。

< pre> A-->B \ C-->D \ \ G E-->F

(图2)

Steve B的建议(代码3)似乎给出了最好的结果，即使在按Alt+Shift+F后仍然保持格式化。

*<p><blockquote><pre>         
* A-->B
*  \
*   C-->D
*    \   \
*     G   E-->F
* </pre></blockquote>

(3)代码

使用代码3产生与图1所示相同的javadoc HTML输出。

除了前面提到的<pre>标记之外，你还应该使用@code JavaDoc注释，这将使HTML实体问题(特别是泛型)变得更容易，例如:

* <pre>
* {@code
* Set<String> s;
* System.out.println(s);
* }
* </pre>

将给出正确的HTML输出:

Set<String> s;
System.out.println(s);

而省略@code块(或使用<code>标记)将导致这样的HTML:

Set s;
System.out.println(s);

作为参考，可以在这里找到Java SE 8中可用的标记描述的完整列表。

java源代码中有很多这样的好例子。下面是"String.java"头部的一个例子:

....
 * is equivalent to:
 * <p><blockquote><pre>
 *     char data[] = {'a', 'b', 'c'};
 *     String str = new String(data);
 * </pre></blockquote><p>
 * Here are some more examples of how strings can be used:
 * <p><blockquote><pre>
 *     System.out.println("abc");
 *     String cde = "cde";
 *     System.out.println("abc" + cde);
 *     String c = "abc".substring(2,3);
 *     String d = cde.substring(1, 2);
 * </pre></blockquote>
...

这是我的意见。

正如其他答案已经说明的那样，您应该将<pre> </pre>与{@code}结合使用。

使用pre和{@code}

包装你的代码在<pre>和</pre>防止你的代码崩溃到一行; 将代码包装在{@code}中可以防止<、>和中间的所有内容消失。当代码包含泛型或lambda表达式时，这尤其有用。

注释的问题

当代码块包含注释时，就会出现问题。这可能是因为当@符号出现在Javadoc行的开头时，它被认为是一个类似于@param或@return的Javadoc标记。例如，这段代码可能被错误地解析:

/**
 * Example usage:
 *
 * <pre>{@code
 * @Override
 * public void someOverriddenMethod() {

以上代码将完全消失在我的情况下。

要解决这个问题，行不能以@符号开头:

/**
 * Example usage:
 *
 * <pre>{@code  @Override
 * public int someMethod() {
 *     return 13 + 37;
 * }
 * }</pre>
 */

注意，@code和@Override之间有两个空格，以保持内容与下一行对齐。在我的例子中(使用Apache Netbeans)，它被正确呈现。