凡把java包级别的信息由javadoc的使用?(Where to put java package

2019-09-24 03:16发布

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

这些部分包括:“java.io包中描述”,“包规范”和“相关文档”。

我应该在哪里把这些部分的内容在我自己的项目,这样的javadoc以同样的方式处理它?

Answer 1:

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

里面做以下

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


Answer 2:

你把在这些意见包注释文件 (重点煤矿):

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

要创建一个包注释文件,你有一个选择的两个文件,将您的意见:

  • package-info.java -可以包含一个包声明,注解包,包注释和Javadoc标记。 此文件通常优于package.html的
  • package.html -只能包含包注释和Javadoc标记,没有包注释。


Answer 3:

你必须把一个名为package-info.java到包含您的软件包的文件夹。



文章来源: Where to put java package-level information to use by javadoc?