强大的工具来生成文档(包括确切的要求)

时间:2011-03-07 15:59:43

标签: maven documentation code-snippets doxia maven-pdf-plugin

简短版

我们需要Maven Doxia替代方案能够生成外观漂亮的PDF(至少代码片段应该正确缩进并具有可配置的字体大小)。 Maven的家伙在maven-pdf-plugin中提出DOXIA-419,但它也有同样的问题。前面提到的DOXIA-419详细介绍了我们在Doxia遇到的困难。

详细版本

我们开发了一个提供Java / C / C ++ / C#/ etc API的BIG产品。同时维护/开发了数十个客户定制的分支机构。 我们需要一种工具来促进满足这些要求的自动文档生成:

  1. 包含Java / XML / etc示例中的任意代码段。 Confluence Snippet Plugin就是这个功能的一个很好的例子。

  2. 生成外观漂亮的可打印文档(例如PDF)。

  3. 生成具有可点击交叉引用等的在线文档(例如HTML)。

  4. 无人参与模式(例如,应该很容易从Ant脚本运行文档生成过程)。

  5. 文档源内容(稍后从中生成PDF /等)应以易于阅读的易读格式保存。

  6. 文档源内容应保存在单独的文件中(不是Java源代码)。

  7. 支持(Java / xml / etc)语法高亮显示。

  8. 更新: 8. Windows操作系统兼容性。

1 个答案:

答案 0 :(得分:3)

我的开源项目Dexy可能适合您。它是一个创作工具而不是自动文档生成工具,因此它不像JavaDoc自动创建整个结构。源代码和文档内容保持独立,语法突出显示支持非常好,文档片段可用。我将LaTeX用于外观漂亮的可打印文档,但如果您愿意,可以使用任何其他基于文本的格式编译为PDF。对于可点击的交叉引用,您必须编写HTML模板,然后可以自动填充(我现在这样做,在项目中替换JavaDoc)。您还可以运行实时代码示例,并在文档中包含此输出。

http://dexy.it