0

精简版

我们需要一个能够生成好看的 PDF 的 Maven Doxia 替代方案（至少代码片段应该正确缩进并具有可配置的字体大小）。Maven 家伙在DOXIA-419中提出了maven-pdf-plugin，但它也有同样的问题。上述 DOXIA-419 详细介绍了我们在使用 Doxia 时遇到的困难。

详细版

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

  1. 包括来自 Java/XML/etc 示例的任意片段。Confluence Snippet Plugin 就是这个特性的一个很好的例子。

  2. 生成好看的可打印文档（例如 PDF）。

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

  4. 无人值守模式（例如应该很容易从 Ant 脚本运行文档生成过程）。

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

  6. 文档源内容应保存在单独的文件中（而不是 Java 源）。

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

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

4

1 回答 1

3

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

http://dexy.it

于 2011-03-08T07:26:29.580 回答