如何在 Java 中记录包？答案

【问题标题】：How Do I Document Packages in Java?如何在 Java 中记录包？
【发布时间】：2010-10-12 02:02:40
【问题描述】：

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

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

【问题讨论】：

【解决方案1】：

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

【讨论】：

【解决方案2】：

直到并包括 Java 1.4，您必须提供 HTML 文件 package.html，如其他答案中所述。

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

【讨论】：

+1 用于提及两种方式，以及它们之间的本质区别。顺便说一句，至少 IntelliJ IDEA 目前对 package.html 有更好的支持（包名上的 Ctrl-Q 显示包 Javadocs）。
更新我之前的评论：现在IDEA支持package-info.java就好了。

【解决方案3】：

从 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

【讨论】：