如何在JavaDoc中自定义“概述”页面？

Question

我喜欢＆＃34; 概述＆＃34;我的库的页面javadoc基本上是整个JAR的用户/ API指南。我知道在包中添加package-info.java类允许您编写包级 javadocs，但是在 jar级别

？

我知道我可以在项目的根目录中放置一个README.md，但我喜欢将README作为图书馆开发人员的文档（也就是那些将成为维护库。但是JavaDocs是那些将使用库的人的API指南。

Answer 1

您可以创建概述HTML文件，并将其放在源树中的任何位置。惯例是将它命名为overview.html并将其放在树的根部，但您当然没有义务这样做。实际上，您可以为不同目的创建多个概述文件。生成javadoc时，使用-overview标志并将其传递给目标概述文件。

您可以找到有关概述文件要求的更多信息here。

Answer 2

使用Maven及其plugin for JavaDoc时：

将名为overview.html的文件放入文件夹src/main/javadoc并运行命令mvn javadoc:javadoc； JavaDoc文件将写入文件夹target/site/apidocs。

当您要为单元测试生成JavaDoc文件时，也可以这样做：将名为overview.html的文件放入文件夹src/test/javadoc并运行命令mvn javadoc:test-javadoc； JavaDoc文件将写入文件夹target/site/testapidocs。