【问题标题】:Java: How can I create good looking class docs with Javadoc?Java:如何使用 Javadoc 创建好看的类文档?
【发布时间】:2011-02-01 18:30:18
【问题描述】:

我想为一个 Java 类库创建 HTML 文档,其中包含

  • 编程指南信息 - 不仅仅是类参考
  • 参考文档中的代码示例
  • 可折叠区域

我希望它看起来很有风格。像这样的:

认为 Javadoc 公开了一个 doclet API,它允许其他方提供集成在 Javadoc 中的文档生成。是否有一个我可以(免费)使用的 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?

【问题讨论】:

    标签: java javadoc doclet


    【解决方案1】:

    也许您正在考虑 Java doclet API:

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

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

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

    【讨论】:

    • 更改 CSS 也应该很简单。
    • @dummymo:据我所知,doclet API 允许额外的 doclet 引擎。换句话说,生成是可插拔的。我在问,还为生成 API 和指导文档生成了哪些其他 doclet? @donal,好的,听起来很简单。怎么样?
    • 您已经获得了输出文件,javadoc 使用生成树根目录中的单个 CSS 文件。如果你不能从那里解决它,我会绝望...... ;-)
    • @Cheeso,为什么要切换到“dummymo”?这不是说服人们尽力而为的好方法。
    • 对不起,错字。我的错。不是故意的。
    【解决方案2】:

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

    【讨论】:

      猜你喜欢
      • 2022-06-15
      • 1970-01-01
      • 1970-01-01
      • 2019-05-06
      • 2011-08-17
      • 1970-01-01
      • 2012-01-19
      • 2010-12-11
      相关资源
      最近更新 更多