java - 如何从 JavaDoc 生成 PDF(包括概述和包摘要)

Question

我已经为我的应用程序编写了大量的 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？

Answer 1

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

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

1. 在releases page上下载软件;

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

3. 图形用户界面很好，但是手动添加所有文件可能很麻烦，所以只需创建一个文档类型设置为“网页”的 .book 文件，从生成的 javadoc 的根文件夹中添加一个 HTML 文件(例如，overview-summary.html，任何人都会这样做，它只是作为第 5 步的引用)。在“输出”选项卡上，选择 PDF 格式并为其设置名称，并为您的内容添加其他选项( Logo 、颜色、这里有很多很酷的东西)。保存此项目(例如，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