如何用Java编写包文档？

在JavaAPI中，我可以看到包的Javadoc注释

---

如何/在何处放置Javadoc注释来记录一个包？

在包级别使用

package.html

文件（即在该包的目录中）。这应该是一个格式完整的

HTML

文件，其中定义了

标记

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

由于Java1.5，您还可以提供一个

包info.Java

，其中包含一个常规的Javadoc注释（无HTML）。后者是首选，因为它为您提供了一些额外的特性（特别是包注释）

详情：

---

从1.5开始，您可以定义

包信息.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

---

更多详细信息？这个文件应该是什么样子的？它是一个HTML文件，包含您的包的描述。就这样！这是老办法。从Java1.5开始，您可以使用PackageInfo.Java+1来说明这两种方法，以及它们之间的本质区别。顺便说一下，至少IntelliJ IDEA目前对package.html有更好的支持（包名上的Ctrl-Q显示包Javadocs）更新我以前的评论：现在IDEA支持

package info.java

很好。直接链接到spec：在intellij中，您可以右键单击一个包，创建该包的选项应该在新文件下。menuI找到需要在packagename/src/packagename中的文件（以及其他源文件）