2012-12-18 38 views
4

我發現我可以在Eclipse中爲Javadoc添加一些CSS樣式,爲內聯代碼懸停創建一些很好的效果。Eclipse中Javadocs的自定義樣式

樣品的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中的外觀。但是,如果我將Javadoc導出爲HTML,我可能希望HTML版本具有與Eclipse版本不同的樣式。

是否有可能在Eclipse中做到這一點,也許有一個插件?

+1

也許不是你但您可以編譯JavaDocs,設置樣式表,然後將項目鏈接到正確的位置以讀取JavaDocs。 –

+0

@TomCammann - 偉大的建議,但它似乎並沒有工作,至少在Eclipse 3.7.1中沒有。附加Javadoc讓我可以在瀏覽器中打開它,但是Eclipse Hover並不使用它。我刪除了.java文件中的javadoc註釋,並且Eclipse懸停顯示爲空,即使我可以單擊「打開連接到瀏覽器」來查看它。 –

回答

1

我認爲,當您將零件導出爲樣式JavaDoc時,可以使用此Java tool。 同時檢查這個book這可能有助於在Eclipse中爲javadoc指定樣式表。 也許你也可能會創建自己的文檔生成插件。

2

通過實驗,我發現我可以使用<link>標記鏈接到樣式表,使用相對於.java文件位置的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; 
}