某些 API 文档包含包级别的信息。例如java.io
包含 3 个包级部分 http://docs.oracle.com/javase/7/docs/api/java/io/package-summary.html
这些部分是:"软件包 java.io 描述"、"软件包规范"和"相关文档"。
我应该将这些部分内容放在我自己的项目中的什么位置,以便javadoc以相同的方式处理它?
包中创建一个名为package-info.java
的文件
里面做以下事情
/**
* Javadoc
*/
package my.cool.package123;
你把这些注释放在一个包注释文件中(强调我的):
每个包都可以有自己的文档注释,包含在自己的"源"文件中,Javadoc 工具将合并到它生成的包摘要页面中。您通常在此注释中包含适用于整个包的任何文档。
要创建包注释文件,您可以选择两个文件来放置注释:
package-info.java
- 可以包含包声明、包注释、包注释和 Javadoc 标记。此文件通常优先于包.html 。package.html
- 只能包含包注释和 Javadoc 标记,不能包含包注释。
您必须将一个名为 package-info.java
的文件放入包含包的文件夹中。