5

Some API docs contain information at package level. For example java.io contains 3 package-level sections here http://docs.oracle.com/javase/7/docs/api/java/io/package-summary.html

The sections are: "Package java.io Description", "Package Specification" and "Related Documentation".

Where should I put these sections content in my own project so that javadoc processes it in the same way?

4

3 回答 3

6

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

里面做以下

/**
 * Javadoc
 */
package my.cool.package123;
于 2012-10-15T14:55:58.327 回答
2

你把这些评论放在一个包评论文件中（强调我的）：

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

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

  • package-info.java- 可以包含包声明、包注释、包注释和 Javadoc 标记。这个文件通常比 package.html 更受欢迎。
  • package.html- 只能包含包注释和 Javadoc 标签，不能包含包注释。
于 2012-10-15T14:56:45.830 回答
1

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

于 2012-10-15T14:56:34.007 回答