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

如何用Java编写包文档?

javadoc packages java

168

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

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

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

3 回复 | 直到 16 年前

271

Gareth Davis 12 年前

从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

user207421 5 年前

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

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

oxbow_lakes 16 年前

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

推荐文章

paulmiller3000 · 安装Python包时出错:路径中缺少make实用程序

7 年前

Shital Shah · Python 3包和脚本中导入的最佳实践

7 年前

Sean Raleigh · 哪些R包在附加时使用某种随机过程?[已关闭]

7 年前

Muhammad Touseef · windows 10的多个应用程序包应具有相同的功能?

7 年前

Sviatoslav · 在Goland的模块中未找到任何用法

7 年前

Milad Rezazadeh · npm包的可安装typescript类型定义

7 年前

jjgasse · 在python中安装程序包时出错

7 年前

fire frost · 创建包SQL developer时出现符号错误

7 年前

Ishan Khare · Kotlin无法导入包

7 年前

ankitom · 在一个kie会话中加载多个包?

7 年前