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

Question

我希望我的库的javadoc 的" Overview "页面基本上是整个JAR的用户/ API指南.我知道package-info.java在包中添加一个类允许你编写包级别的 javadocs,但是在jar级别呢？

我知道我可以README.md在项目的根目录中添加一个,但我喜欢将README视为库开发人员的文档(即,将维护库的人).但JavaDocs是将要使用该库的人的API指南.

Answer 1

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

您可以在此处找到有关概述文件要求的更多信息.