javadoc 使用的 java 包级信息放在哪里？答案

【问题标题】：Where to put java package-level information to use by javadoc?javadoc 使用的 java 包级信息放在哪里？
【发布时间】：2012-10-05 13:59:45
【问题描述】：

一些 API 文档包含包级别的信息。例如java.io 在这里包含 3 个包级部分 http://docs.oracle.com/javase/7/docs/api/java/io/package-summary.html

这些部分是：“包 java.io 描述”、“包规范”和“相关文档”。

我应该将这些部分内容放在我自己的项目中的什么位置，以便 javadoc 以相同的方式处理它？

【问题讨论】：

标签： java package javadoc

【解决方案1】：

您将这些 cmets 放入 package comment file（重点是我的）：

每个包都可以有自己的文档注释，包含在自己的“源”文件中，Javadoc 工具将合并到它生成的包摘要页面中。您通常在此注释中包含适用于整个包的任何文档。

要创建包注释文件，您可以选择两个文件来放置 cmets：

package-info.java - 可以包含包声明、包注释、包 cmets 和 Javadoc 标记。 这个文件通常比 package.html 更受欢迎。

package.html - 只能包含包 cmets 和 Javadoc 标签，不能包含包注释。

【讨论】：

【解决方案2】：

您必须将一个名为 package-info.java 的文件放入包含您的包的文件夹中。

【讨论】：

【解决方案3】：

在每个包中创建一个名为package-info.java 的文件

在里面做以下操作

/**
 * Javadoc
 */
package my.cool.package123;

【讨论】：