某些API文档包含包级别的信息。例如,java.io
在此处包含3个包级别的部分http://docs.oracle.com/javase/7/docs/api/java/io/package-summary.html
这些部分是:“包java.io描述”,“包规范”和“相关文档”。
我应该将这些部分内容放在我自己的项目中,以便javadoc以相同的方式处理它?</ p>
答案 0 :(得分:5)
在每个包中创建一个名为package-info.java
的文件
在里面做以下
/**
* Javadoc
*/
package my.cool.package123;
答案 1 :(得分:2)
您将这些评论放在package comment file(强调我的)中:
每个包都有自己的文档注释,包含在自己的“源”文件中,Javadoc工具将合并到它生成的包摘要页面中。您通常在此注释中包含适用于整个包的任何文档。
要创建包评论文件,您可以选择两个文件来发表评论:
package-info.java
- 可以包含包声明,包注释,包注释和Javadoc标记。 此文件通常比package.html 更受欢迎。package.html
- 只能包含包注释和Javadoc标记,不能包含注释。
答案 2 :(得分:1)
您必须将名为package-info.java
的文件放入包含您的包的文件夹中。