代码之家 › 专栏 › 技术社区 › jjnguy Julien Chastang

如何用Java编写包文档?

javadoc packages java

168

jjnguy Julien Chastang · 技术社区 · 17 年前

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

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

3 回复 | 直到 17 年前

1

271

Gareth Davis 13 年前

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

/**
 * com.foo is a group of bar utils for operating on foo things.
 */
package com.foo;

//rest of the file is empty

2

51

user207421 6 年前

在Java1.4之前(包括Java1.4),您必须提供一个HTML文件package.HTML,如其他答案中所述。

package-info.java ,其中包含常规的Javadoc注释(无HTML)。后者是首选,因为它为您提供了一些额外的特性(特别是包注释)。

3

4

oxbow_lakes 17 年前

用一个 package.html HTML 文件,带有 <html>