【问题标题】:How to generate a PDF from JavaDoc (including overview and package summaries)如何从 JavaDoc 生成 PDF(包括概述和包摘要)
【发布时间】:2011-01-20 07:00:53
【问题描述】:

我已经为我的应用程序编写了大量的 JavaDoc 文档,并在 overview.html 和 package.html 文件中添加了许多有用的信息(包括前者的链接到 doc-files/ 中的插图)。 Maven 的 Javadoc 插件很好地使用了标准的 javadoc 工具来生成经典的 JavaDoc 框架集,但现在我需要生成包含整个文档的 PDF。

AurigaDoclet 生成非常漂亮的 PDF,我也可以使 DocFlex 工作。但是,两者都忽略了我的 overview.html 和 package.html 文件(在 Maven 内部和外部都尝试过 - PDF 将是一次性的,因为从长远来看我宁愿拥有 HTML)。

有谁知道如何让 AurigaDoclet 识别我的非 Java 文件?或者,另一种方法是从源代码或 JavaDoc 生成的 HTML 生成一个看起来不错的 PDF?

【问题讨论】:

    标签: java pdf javadoc maven-pdf-plugin


    【解决方案1】:

    成功了。在尝试了所有可能的直接从源代码生成的工具之后,我回到了HTMLDOC。它不支持 JavaDoc,但它构建得非常好,只需进行一些调整就足以使它生成一个非常有用的 PDF。

    下面是我如何做到的一步一步的描述:

    1. 在releases page上下载软件;

    2. 以您喜欢的方式(Ant、Maven、命令行 javadoc - 您的选择)生成您的传统 HTML 文档;

    3. GUI 很好,但手动添加所有文件可能很麻烦,因此只需创建一个文档类型设置为“网页”的 .book 文件,然后从生成的 javadoc 的根文件夹中添加一个 HTML 文件(例如,overview-summary.html,任何人都可以,它只是在步骤 5 中的参考)。在“输出”选项卡上选择 PDF 格式并为其设置名称,并为您的内容添加其他选项(徽标、颜色、这里有很多很酷的东西)。保存此项目(例如,myjavadocpdf.book)并关闭 GUI

    4. 在您的 javadoc 中生成所有 HTML 文件的列表。我是用Cygwin 的 find 命令完成的(我的 DOS/cmd shell 时代已经结束了),但是只要你得到一个文件列表,你就可以做任何你想做的事情。就我而言,find . | grep html$ | sort -r > files.txt 成功了; 对于 Windows 用户,dir /s/b *.html > files.txt 也应该这样做(但请记住,如果在下一步中出现类似情况,您可能需要将 \s 替换为 /s)。

    5. 在你最喜欢的纯文本编辑器中打开第 3 步生成的 .book 文件(作为程序员,你应该对此有强烈的意见,所以我的意见要留给自己 - NOT ;-))并附加在第 4 步生成的列表到此 .book 文件(它将文件列表保留在最后,让生活变得非常轻松)。如果需要,请不要忘记使用全局搜索/替换来修复相对路径(这就是为什么您需要在步骤 3 中添加至少一个文件 - 以查看 htmldoc 期望的文件路径模式);

    6. 现在您应该按照方便的顺序对文件进行排序。我把我的概述放在第一位,然后是包描述和每个类,然后是完整的索引,最后是其他所有内容。请记住,您删除的任何文件都将成为外部(因此损坏)链接,因此请谨慎选择;

    7. 保存您的 .book 文件并在 HTMLDOC 上重新打开它。瞧:添加和排序的所有文件。点击生成。就是这样!

    您可能想要摆弄图像(提示:使用 HTML 宽度/高度,而不是样式/css)。最后,生成的文件非常好:外观漂亮,内部和外部链接完全可导航。当您认为该工具根本不支持 Java(Doc) 时,令人印象深刻...

    编辑:软件现在从原作者那里免费;更新链接,谢谢@mohammed

    【讨论】:

    • Mac OS 用户可以从code.google.com/p/rudix/wiki/htmldoc 下载包。它没有 GUI,因此您必须找到 example of .book file 并对其进行修改。然后使用命令htmldoc --batch htmldoc.book生成pdf
    • 仅供参考,在这里可以找到 mac 版本的二进制文件:rudix.org/packages/htmldoc.html 注意它在 Yosemite 上确实有一个 GUI
    • 建议的程序在 Windows 下运行良好,但我必须在插入到 .book 文件中的生成列表中将所有“\”字符替换为“/”
    • 感谢@jmd,将该信息添加到程序中。
    • 答案中的链接似乎已损坏/移动。这是msweet.org/htmldoc/index.html 上的更新
    【解决方案2】:

    根据 Sun JavaDoc 常见问题解答,有几个选项 - 大部分是免费的,还有一两个商业产品。查看http://java.sun.com/j2se/javadoc/faq/index.html#print。

    【讨论】:

    • 从那个页面我尝试了 MIF Doclet(与注释不兼容)、html2ps(几乎不可能在 Windows 上工作,这是我现在在海外遇到的问题)和 HTMLDOC(这需要购买或在我第一次尝试时没有成功的构建)。仍然必须检查 PDFDoclet,但决定先在这里询问以确保确定(毕竟,两个 doclet 不做完全相同的事情可能会发现我可能遗漏的一些明显的东西,参数/设置)。您(或任何人)以前在这种情况下使用过它吗?谢谢!
    • 不幸的是,不,我没有——目前我正在与一个足够小的团队合作,打印文档并没有太大的好处,而且代码仍然足够新无论如何,文档的硬拷贝在几周内就会过时。
    • 是的,我完全同意:大多数 JavaDocs 的真正价值在于它们的“实时”特性。但这是一个外部请求... :-/
    • 您可能还需要考虑 iText java 库和运行您自己的 PDF 生成器。我是从我的手机中添加这个的,所以目前我很难获得链接,但它是一个相当流行的库——只是谷歌 iText java pdf。这比仅仅运行一个工具要困难一些,但你总是可以将它发布给有这个问题的任何其他人。不幸的是,您可能需要另一个库来解析 HTML 文件 - 可能不需要,但很可能,因为我认为 iText 只是 PDF。
    • PDFDoclet 也没有运气——它生成漂亮的 PDF,但忽略了 overview.html(至少它打印了 AurigaDoclet 忽略的包描述)。尝试使用 -overview 参数(PDFDoclet 报告错误,无论我设置为概述文件,这表明它立即拒绝该参数,并且 AurigaDoclet 只是在吞噬),并将默认包添加为“。” (javadoc 拒绝)。卡住了:-(
    【解决方案3】:

    AurigaDoclet 无法处理 package.html。 有关修复,请参阅我在 https://sourceforge.net/projects/aurigadoclet/forums/forum/339169/topic/1572199/index/page/1 的评论

    【讨论】:

      【解决方案4】:

      如果这个问题还是被碰到了,我可以用它来链接我的ltxdoclet 项目。

      这会从源文件(通过作为 JavaDoc 插件)创建 LaTeX 格式的文档,然后您可以通过 PdfLaTeX 生成 PDF。

      它还可以包含印刷精美的源代码。

      【讨论】:

        猜你喜欢
        • 2017-08-04
        • 1970-01-01
        • 1970-01-01
        • 2015-07-26
        • 2012-07-12
        • 2011-03-07
        • 2021-05-16
        • 2017-05-20
        • 2017-11-22
        相关资源
        最近更新 更多