java - 如何在 Java 中记录包？

Question

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

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

score 272 · Accepted Answer

从 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

score 51 · Accepted Answer

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

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

score 3 · Accepted Answer

使用package.html包级别的文件（即在该包的目录中）。这应该是一个完整的HTML文件，其中<html>定义了标签

3 回答 3