如何在 Java 中记录包？

packages java javadoc

2022-08-31 06:15:59

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

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

答案 1

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

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

答案 2

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

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

推荐