Eclipse中Javadocs的自定义样式

时间:2012-12-18 18:21:24

标签: css eclipse javadoc

我发现我可以在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 hover example

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

  1. 如果我后来决定调整样式,我可能需要更改数百个Javadoc注释
  2. 目前,我只关心Eclipse中的外观。但是,如果我将Javadocs导出为HTML,我可能希望HTML版本的样式与Eclipse版本不同。
  3. 是否可以在Eclipse中执行此操作,可能使用插件?

2 个答案:

答案 0 :(得分:2)

通过实验,我发现我可以使用<link>标记链接到样式表,其中href相对于.java文件位置。这确实解决了问题中提到的问题#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;
}

答案 1 :(得分:1)

我认为当您将部件导出为样式化JavaDoc时,可以使用此Java tool。 另请查看此book,这可能有助于在Eclipse中为javadoc指定样式表。 也许你也可以创建自己的doc生成插件。