Java:如何使用Javadoc创建外观漂亮的类文档?

时间:2010-03-28 15:40:44

标签: java javadoc doclet

我想为包含

的Java类库创建HTML文档
  • 编程指南信息 - 超越课堂参考
  • 参考文档中的代码示例
  • 可折叠区域

我希望它看起来很好看。像这样:

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

认为 Javadoc公开了一个doclet API,允许其他方提供集成在Javadoc中的doc生成。是否有一个doclet选项,我可以使用(免费)做一些比标准的javadoc输出更好的东西?

我试着谷歌搜索但没有运气。 建议?

附录
我发现doclet.com但我不知道如何评估选项。建议?

特别是,XHtmlDoclet听起来似乎想要解决这些问题。有人用过吗? I can't get it to work。此外,example offered by the XHTML Doclet guys看起来并不比the docs generated from c.1998 javadoc好。


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

2 个答案:

答案 0 :(得分:1)

也许您正在考虑Java doclet API:

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

您似乎在添加示例和一些文字。我认为现有的javadoc完全有可能。问题将是内容而不是渲染。

Castor使用doclet来减轻配置负担。 EJB 1.0也是如此。如果你愿意的话,看看那些。

答案 1 :(得分:1)

这个问题让我思考(好吧,谷歌搜索),我偶然发现this set of taglets。从来没有尝试过,但看起来很有希望。