如何用Java记录包?

时间:2009-03-08 22:17:42

标签: java packages javadoc

在Java API中,我可以看到包的Javadoc注释。

我如何/在何处放置Javadoc注释来记录包?

3 个答案:

答案 0 :(得分:243)

从1.5开始,您可以定义package-info.java文件并为包提供标准的javadoc样式注释:

COM /富/ package-info.java:

/**
 * com.foo is a group of bar utils for operating on foo things.
 */
package com.foo;

//rest of the file is empty

Language specification for packages

答案 1 :(得分:43)

在Java 1.4之前,您必须提供HTML文件package.html,如其他答案中所述。

从Java 1.5开始,您还可以提供package-info.java,其中包含常规Javadoc注释(无HTML)。后者是首选,因为它为您提供了一些额外的功能(特别是包注释)。

详细说明: Sun's docs for javadoc

答案 2 :(得分:4)

在包级别使用package.html文件(即在该包的目录中)。这应该是一个完整格式的HTML文件,其中定义了<html>标记