首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >如何在Java中文档包?

如何在Java中文档包?
EN

Stack Overflow用户
提问于 2009-03-08 22:17:42
回答 3查看 57.8K关注 0票数 197

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

如何/在哪里放置Javadoc注释来文档包?

EN

回答 3

Stack Overflow用户

回答已采纳

发布于 2009-03-08 22:42:24

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

com/foo/package-info.java:

代码语言:javascript
复制
/**
 * com.foo is a group of bar utils for operating on foo things.
 */
package com.foo;

//rest of the file is empty

Language specification for packages

票数 272
EN

Stack Overflow用户

发布于 2009-03-08 22:42:13

在Java1.4之前,您必须提供一个超文本标记语言文件package.html,如其他答案中所述。

从Java1.5开始,您还可以提供一个package-info.java,它包含常规的Javadoc注释(没有超文本标记语言)。后者是首选,因为它为您提供了一些额外的功能(特别是包注释)。

详情:Sun's docs for javadoc

票数 51
EN

Stack Overflow用户

发布于 2009-03-08 22:18:51

包级别的package.html文件(即,在该包的目录中)。这应该是一个格式完整的HTML文件,其中定义了<html>标记

票数 3
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/624422

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档