5

我发现我可以在 Eclipse 中向 Javadocs 添加一些 CSS 样式,为内联代码悬停创建一些不错的效果。

示例 javadoc:

/**
 * <p>This is a general description of the class.<p>
 * 
 * <p>Here is a useful direct quote:</p>
 * 
 * <div style="background-color:white; border: 1px solid gray; margin: 1em 2.5em; padding: 0em 0.5em">
 *   <p>This quote has a list:</p>
 *   <ul>
 *     <li>Item 1</li>
 *     <li>Item 2</li>
 *   </ul>
 * </div>
 *
 */
public class SSCCE {

}

样本结果: Javadoc 悬停示例

我想在我的代码中更多地利用这一点,但如果我可以使用类似的东西<div class="box">而不是手动设置样式属性会更好,原因如下:

  1. 如果我以后决定调整样式,我可能需要更改数百个 Javadoc 注释
  2. 目前,我只关心 Eclipse 中的外观。但是,如果我曾经将 Javadocs 导出为 HTML,我可能希望 HTML 版本具有与 Eclipse 版本不同的样式。

是否可以在 Eclipse 中执行此操作,也许使用插件?

4

2 回答 2

2

通过实验,我发现我可以使用相对于 .java 文件位置的<link>标签链接到样式表。href这确实解决了问题中提到的问题#1,但我个人认为它太麻烦了,可能不会使用它。它也不能解决问题#2(如果有的话,它会使情况变得更糟)。

我仍然愿意接受更好的解决方案的建议!我怀疑虽然它需要一个 Eclipse 插件才能完全实现我真正想做的事情。

[项目根]/src/org/foobar/Foo.java:

package org.foobar;

/**
 * <link rel="stylesheet" type="text/css" href="../../../javadoc.css"/>
 * 
 * <p class="orange">Foo doc, in orange</p>
 */
public class Foo {

}

[项目根]/javadoc.css

p.orange {
    color: orange;
}
于 2012-12-19T00:22:00.970 回答
1

我认为当您将部分导出为样式化的 JavaDoc 时,您可以使用这个Java 工具。还可以查看这本书,它可能有助于在 Eclipse 中为 javadoc 指定样式表。也许您还可以创建自己的文档生成插件。

于 2012-12-18T21:21:47.460 回答