首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >生成文档的强大工具(包括精确的需求)

生成文档的强大工具(包括精确的需求)
EN

Stack Overflow用户
提问于 2011-03-07 15:59:42
回答 1查看 944关注 0票数 0

短版

我们需要一个Maven Doxia替代方案,能够生成好看的PDF(至少代码段应该适当缩进并具有可配置的字体大小)。Maven人员在DOXIA-419中提出了DOXIA-419,但它也有同样的问题。上述DOXIA-419详细介绍了我们在Doxia公司遇到的困难。

详细版本

我们开发了一个提供Java/C/C++/C#/etc API的大型产品。数十个客户定制的分支被同时维护/开发。我们需要一个工具来帮助自动生成符合这些要求的文件:

  1. 包括来自Java/XML/etc示例的任意片段。汇合片段插件就是这个特性的一个很好的例子。
  2. 生成好看的可打印文档(例如PDF)。
  3. 生成具有可点击交叉引用等的在线文档(例如HTML)。
  4. 无人参与模式(例如,应该很容易从Ant脚本运行文档生成过程)。
  5. 文档源内容(PDF/etc是从其中生成的)应该保持在人类可读的、易于区分的格式中。
  6. 文档源内容应该保存在单独的文件中(而不是Java源代码)。
  7. 支持(Java/xml/etc)语法突出显示。

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

EN

回答 1

Stack Overflow用户

发布于 2011-03-08 07:26:29

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

http://dexy.it

票数 3
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/5221834

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档