我如何在Java文档包?

在Java api中，我可以看到包的Javadoc注释。

如何/在哪里放置Javadoc注释来记录包?

60584 次浏览

小开

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

小开

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

从Java 1.5开始，你还可以提供package-info.java，它包含一个常规的Javadoc注释(没有HTML)。后者是首选，因为它提供了一些额外的特性(尤其是包注释)。

< p >细节: Sun的javadoc文档 < / p >

小开

最佳答案

从1.5版开始，你可以定义一个package-info.java文件，并为包提供一个标准的javadoc风格的注释:

com/foo/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