@param 描述以代码字体显示

Question

我正在为以下简单示例生成 javadoc：

public class test {
  /**
   * foo does something.
   *
   * @param x the parameter
   */
  public void foo(int x) {}
}

我运行javadoc test.java.

我希望 x 以非比例字体显示名称，并以比例字体显示描述，例如官方 JDK javadoc。相反，我得到了此捕获中显示的内容：

这对于简短的描述来说还可以，但对于较长的描述来说就很丑陋了。我做错了什么？

Answer 1

当您比较 Object.equals(obj) 和 Java 7 and Java 8 的 Java API 文档时，您会发现

的字体差异

Parameters:

obj - the reference object with which to compare.

部分。你也会看到所有其他方法的参数，我只是选择了众所周知的方法作为例子。

换句话说，这是 JavaDoc 在 Java 7 和 Java 8 的当前版本之间行为的一般变化，您没有做错任何事情。

如果您查看 the stylesheet，您会发现负责描述部分的定义从包含属性 font-family:'DejaVu Sans Mono',monospace;.

的第 287 行开始

@param description showing up in code font