如何在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

回答