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

我希望我的库的javadoc的“概述”页面基本上成为整个JAR的用户/ API指南。我知道在一个包中添加一个package-info.java类可以让您编写包级 javadoc，但是如何在jar级别？如何在JavaDoc中自定义“概述”页面？

我知道我可以把README.md在我的项目的根，但我喜欢把README文件作为库开发一个文档（即，人谁是保持库）。但是JavaDocs是使用库的人将使用的的API指南。

2014-09-20 smeeb

你为什么不为JavaDoc和'README.wateveryoulike'为维护者提供'README.md'？ – msrd0 2014-09-20 10:47:39

可能是因为我喜欢@ Flic的回答:-) – smeeb 2014-09-20 11:53:55

您可以创建一个概述HTML文件，并将其放置在源代码树中的任何位置。约定是将其称为overview.html并将其放置在树的根部，但您当然没有义务这样做。实际上，您可以为不同的目的创建多个概览文件。生成javadoc时，使用-overview标志并将其路径传递到目标概述文件。

你可以找到更多关于概述文件要求here信息。

2014-09-20 10:55:09 Flic

这是真的，但添加overview.html文件是否覆盖所有现有的自动生成的HTML？我只想添加一些文本，而不必重做自动生成的链接。思考？ – 2016-10-07 18:15:18

啊，我明白了。刚刚尝试过。它将HTML文件的内容添加到现有的HTML文件中。它不覆盖它。 – 2016-10-07 20:27:17

回答