pdf - 使用 Maven 维护用户文档

标签 pdf maven-2 documentation latex docbook

关闭。这个问题不符合Stack Overflow guidelines .它目前不接受答案。












想改进这个问题?将问题更新为 on-topic对于堆栈溢出。

4年前关闭。




Improve this question




我们正在使用 Maven 构建 Java 服务器样式的应用程序。它由几个模块(在单个 Maven“ react 器”中)组成,可以将它们插入在一起以生成具有客户需要的功能的最终产品(本质上是 .jar)。所有内部都使用 JavaDoc 和所有文档进行记录,但这不是您可以提供给客户以了解如何让事情运行的内容。目前我们有一个 OpenOffice 文档作为最终用户文档。

我想将此文档集成到 Maven 构建过程中,其中每个模块的文档与模块的源代码一起维护(手动编辑),最终文档可以引用所需的模块文档部分,添加一些友好的前言,如果可能的话所有,可以引用到JavaDocs。最终,文档应以 PDF 格式输出。

有没有关于 Maven 插件的经验可以帮助解决这个问题? DocBook 是正确的工具吗?也许是 latex ?还是完全不同的东西?一个声音“坚持使用 OpenOffice 和一些文本 block ”也可能是一个答案。

最佳答案

我假设你没有看过 Maven site documentation generation然而,maven-site-plugin .它非常健壮,允许您合并和包含 JavaDoc 生成以及 OpenOffice 文档中的内容。

虽然站点文档不会以 PDF 格式输出,但它会以静态 HTML 网站的形式输出,该网站具有许多内置功能。使用 Maven 配置文件,您可以将 Maven 配置为生成一个供内部使用的站点,其中包括 Surefire 测试结果和Checkstykle 和 PMD 等检查的其他报告。在另一个配置文件中,您可以将其配置为仅生成分发给客户所需的文档,其中不包括客户可能不关心的内部报告。

不过需要注意的是,Maven 3 的大部分站点文档生成正在发生变化。虽然 Maven 3 的大部分内容都向后兼容 Maven 2,但请注意 Maven 3 的报告更改。查看以下链接:

  • Site Generation Compatibility
  • Converting maven-site-plugin for Maven 3
  • 关于pdf - 使用 Maven 维护用户文档,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/4657284/

    相关文章:

    c3p0 ComboPooledDataSource 类的文档?

    ios - 仅生成 pdf : swift on 11. 3 的写入权限

    ios - 如何在保存 pdf 的列表中建议我的应用程序?

    maven-2 - Maven : downloading files from url

    maven-2 - Maven clean 无法删除 MySql jar

    visual-studio-2010 - 如何显示你在xml评论中设置的评论文字?

    php - 如何使用composer在Symfony2中安装phpdoc

    pdf - 这个字符串语法在 PDF 中意味着什么?

    c# - 合并在 PDF 中多次使用的同一图像

    maven-2 - 使用 Ivy、Maven 以及 POM 的问题