【问题标题】:@param description showing up in code font@param 描述以代码字体显示
【发布时间】:2016-02-05 16:51:02
【问题描述】:

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

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

我运行javadoc test.java

我希望x 的名称以非比例字体显示,而描述则以比例字体显示,就像官方 JDK javadocs 一样。相反,我得到了此捕获中显示的内容:

这对于简短的描述来说是可以的,但对于较长的描述来说就很难看。我做错了什么?

【问题讨论】:

    标签: java-8 javadoc


    【解决方案1】:

    当您比较 Object.equals(obj)Java 7Java 8 的 Java API 文档时,您会看到字体的不同

    参数:

    obj - 要与之比较的参考对象。

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

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

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

    【讨论】:

    • 感谢霍尔格。你知道是否有办法通过一些 javadoc 标志来驱动旧样式?
    • 如果你要一个简单的标志,我不知道这样的事情。但是当您创建样式表的副本并对其进行修改时,您可以使用-stylesheetfile 选项告诉 javadoc 使用您自定义的样式表。
    • 很好的答案。这不可能是故意的吧?我认为这一定是一个错误,因为我无法想象有人会认为这样的等宽描述看起来更好。希望他们在未来的版本中修复它。在那之前,我正在使用您建议的自定义样式表。谢谢!
    • @TypeIA JDK 9 已经修复了这个问题。外观仍然与 JDK 7 生成的文档不同,因为它们现在使用不同的字体。与Object.equals(obj) for Java 9比较…
    猜你喜欢
    • 1970-01-01
    • 2020-12-13
    • 1970-01-01
    • 2021-12-02
    • 1970-01-01
    • 1970-01-01
    • 2020-02-24
    • 2018-02-03
    • 2019-11-06
    相关资源
    最近更新 更多