2010-03-28 28 views
2

我想爲Java類庫,包括Java:我如何用Javadoc創建好看的類文檔?

  • 節目指南信息創建HTML文件 - 不僅僅是一類參考
  • 代碼示例的參考文檔
  • 可摺疊地區

我希望它看起來很好。事情是這樣的:

alt text http://i40.tinypic.com/25qqjbq.jpg

認爲是公開的Javadoc的doclet一個API,允許其他各方提供的文檔生成集成的Javadoc。是否有一個doclet選項,我可以使用(免費),比標準的javadoc輸出更好一點?

我嘗試了谷歌搜索,但沒有運氣。 建議?

附錄
我發現doclet.com,但我不知道如何評價的選項。建議?

特別是,XHtmlDoclet聽起來像是想解決這些問題。任何人使用它? I can't get it to workexample offered by the XHTML Doclet guys也不比the docs generated from c.1998 javadoc好看。


相關:
Why does Javadoc generate non-compliant XHTML?

回答

1

這個問題讓我想到了(好吧,谷歌搜索),我偶然發現了this set of taglets。從來沒有嘗試過,但它看起來很有希望。

1

也許你會想的Java API的doclet的:

http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html

看來,您要添加的實例和一些文字。我認爲現有的javadoc完全有可能。問題將是內容而不是渲染。

Castor使用doclet來緩解其配置負擔。 EJB 1.0也是如此。如果你願意的話,請看看這些。

+0

更改CSS也應該是微不足道的。 – 2010-03-28 15:52:07

+0

@dummymo:就我所知,doclet API允許使用其他doclet引擎。換句話說,這一代是可插拔的。我在問,爲生成API和指導文檔,還生成了哪些其他doclet? @donal,好的,聽起來很簡單。怎麼樣? – Cheeso 2010-03-28 15:53:18

+0

您已經獲得了輸出文件,javadoc在生成的樹的根目錄中使用單個CSS文件。如果你不能從那裏工作,我絕望...... ;-) – 2010-03-28 16:21:28