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

问题描述 投票:10回答:2

我希望我的库的Javadoc的“ 概述”页面实质上是整个JAR的用户/ API指南。我知道将package-info.java类添加到包中可以编写package-level javadocs,但是在jar-level上呢?

[我知道我可以在项目的根目录中放入README.md,但我想将README当作图书馆开发人员(即将maintaining

该图书馆的人的文档)。但是JavaDocs是针对将成为[[using库的人]的API指南。我希望图书馆的Javadoc的“概述”页面实质上是整个JAR的用户/ API指南。我知道将package-info.java类添加到包中使您可以编写包级...
java javadoc
2个回答
18
投票
您可以创建概述HTML文件,并将其放在源代码树中您喜欢的任何位置。惯例是将其命名为overview.html并将其放置在树的根目录中,但是您当然没有义务这样做。实际上,您可以为不同的目的创建多个概述文件。生成javadocs时,请使用-overview标志并将其路径传递到目标概述文件。

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


0
投票
[使用Maven及其plugin for JavaDoc时:
© www.soinside.com 2019 - 2024. All rights reserved.