文档章节

javadoc

吴伟祥
 吴伟祥
发布于 2017/08/19 20:47
字数 503
阅读 12
收藏 0

javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。

javadoc命令是用来生成自己API文档的,使用方式:使用命令行在目标文件所在目录输入javadoc +文件名.java

标签 说明 JDK 1.1 doclet 标准doclet 标签类型
@author 作者 作者标识 包、 类、接口
@version 版本号 版本号 包、 类、接口
@param 参数名 描述 方法的入参名及描述信息,如入参有特别要求,可在此注释。 构造函数、 方法
@return 描述 对函数返回值的注释 方法
@deprecated 过期文本 标识随着程序版本的提升,当前API已经过期,仅为了保证兼容性依然存在,以此告之开发者不应再用这个API。 包、类、接口、值域、构造函数、 方法
@throws异常类名 构造函数或方法所会抛出的异常。
  
构造函数、 方法
@exception 异常类名 同@throws。 构造函数、 方法
@see 引用 查看相关内容,如类、方法、变量等。 包、类、接口、值域、构造函数、 方法
@since 描述文本 API在什么程序的什么版本后开发支持。 包、类、接口、值域、构造函数、 方法
{@link包.类#成员 标签} 链接到某个特定的成员对应的文档中。
  
包、类、接口、值域、构造函数、 方法
{@value} 当对常量进行注释时,如果想将其值包含在文档中,则通过该标签来引用常量的值。
  
√(JDK1.4) 静态值域

此外还有@serial、@serialField、@serialData、{@docRoot}、{@inheritDoc}、{@literal}、{@code} {@value arg}几个不常用的标签,由于不常使用,我们展开叙述,感兴趣的读者可以查看帮助文档。

© 著作权归作者所有

吴伟祥

吴伟祥

粉丝 31
博文 489
码字总数 284785
作品 0
泉州
后端工程师
私信 提问
Spring Data Lovelace SR3, Kay SR12 和 Ingalls SR17 发布

Spring Data 团队宣布推出 Lovelace SR3, Kay SR12 和 Ingalls SR17 维护版本,这三个版本分别基于最新的 Spring Framework 5.1.3, 5.0.11 和 4.3.21。即将发布的 Spring Boot 版本(2.1.1...

局长
2018/11/28
384
0
Arquillian Core 1.1.10.Final 发布,单元测试框架

Arquillian Core 1.1.10.Final 发布,发行细节: Component Arquillian Core Version 1.1.10.Final view tag Release date 2015-10-19 Released by Aslak Knutsen Compiled against ShrinkW......

叶秀兰
2015/10/20
833
1
Spring Data Ingalls SR14 和 Kay SR9 发布

Spring Data Ingalls SR14 和 Kay SR9 已发布。 Kay SR9 基于刚刚发布的 Spring Framework 5.0.8 之上,Spring Boot 2.0.4 选中了 Kay SR9,将为你提供方便,而 Ingalls SR14 则被 Spring B...

淡漠悠然
2018/07/29
372
0
Spring Data Lovelace SR5 发布

Spring Data 团队宣布推出 Lovelace SR5 维护版本,此版本基于最新的 Spring Framework 5.1.5。此外,为了方便开发者,Spring Boot 2.1.3 也将提供对其的支持。 该版本的发布主要是修复 bug ...

局长
02/14
879
0
Spring Data Lovelace SR1、Kay SR11 和 Ingalls SR16 发布

Spring Data 团队宣布推出 Lovelace SR1、Kay SR11 和 Ingalls SR16 维护版本,这三个版本分别基于最新的 Spring Framework 5.1.1、5.0.10 和 4.3.20 。 新版本主要包含 Bug 修复和一些依赖项...

淡漠悠然
2018/10/16
350
0

没有更多内容

加载失败,请刷新页面

加载更多

mysql-connector-java升级到8.0后保存时间到数据库出现了时差

在一个新项目中用到了新版的mysql jdbc 驱动 <dependency>     <groupId>mysql</groupId>     <artifactId>mysql-connector-java</artifactId>     <version>8.0.18</version> ......

ValSong
今天
5
0
Spring Boot 如何部署到 Linux 中的服务

打包完成后的 Spring Boot 程序如何部署到 Linux 上的服务? 你可以参考官方的有关部署 Spring Boot 为 Linux 服务的文档。 文档链接如下: https://docs.ossez.com/spring-boot-docs/docs/r...

honeymoose
今天
6
0
Spring Boot 2 实战:使用 Spring Boot Admin 监控你的应用

1. 前言 生产上对 Web 应用 的监控是十分必要的。我们可以近乎实时来对应用的健康、性能等其他指标进行监控来及时应对一些突发情况。避免一些故障的发生。对于 Spring Boot 应用来说我们可以...

码农小胖哥
今天
9
0
ZetCode 教程翻译计划正式启动 | ApacheCN

原文:ZetCode 协议:CC BY-NC-SA 4.0 欢迎任何人参与和完善:一个人可以走的很快,但是一群人却可以走的更远。 ApacheCN 学习资源 贡献指南 本项目需要校对,欢迎大家提交 Pull Request。 ...

ApacheCN_飞龙
今天
5
0
CSS定位

CSS定位 relative相对定位 absolute绝对定位 fixed和sticky及zIndex relative相对定位 position特性:css position属性用于指定一个元素在文档中的定位方式。top、right、bottom、left属性则...

studywin
今天
9
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部