【Java】Javadoc的使用
一、名词解释
二、写在类上
1. @link:{@link 包名.类名#方法名(参数类型)} 用于快速链接到相关代码
使用此文档标记的类或者方法,可用通过按住Ctrl键+单击 可以快速跳到相应的类或者方法上,解析成html其实就是使用< code> 包名.类名#方法名(参数类型)< /code>
2. @code: {@code text} 将文本标记为code
将文本标记为代码样式的文本,在code内部可以使用 < 、> 等不会被解释成html标签, code标签有自己的样式一般在Javadoc中只要涉及到类名或者方法名,都需要使用@code进行标记。
3. @param
一般类中支持泛型时会通过@param来解释泛型的类型
4. @author
详细描述后面一般使用@author来标记作者,如果一个文件有多个作者来维护就标记多个@author,@author 后面可以跟作者姓名(也可以附带邮箱地址)、组织名称(也可以附带组织官网地址)
5. @see
@see 一般用于标记该类相关联的类,@see即可以用在类上,也可以用在方法上。
6. @since 从以下版本开始
@since 一般用于标记文件创建时项目当时对应的版本,一般后面跟版本号,也可以跟是一个时间,表示文件当前创建的时间
7. @version 版本
@version 用于标记当前版本,默认为1.0
三、写在方法上
1. @param
@param 后面跟参数名,再跟参数描述
2. @return
@return 跟返回值的描述
3. @throws
@throws 跟异常类型 异常描述 , 用于描述方法内部可能抛出的异常
4. @exception
用于描述方法签名throws对应的异常
5. @see
@see既可以用来类上也可以用在方法上,表示可以参考的类或者方法
6. @value
用于标注在常量上,{@value} 用于表示常量的值
7. @inheritDoc
@inheritDoc用于注解在重写方法或者子类上,用于继承父类中的Javadoc
引用:https://blog.csdn.net/vbirdbest/article/details/80296136
最新文章
- Java面试之SpringMVC总结以及在面试中的一些问题.
- CsvReader,CsvWriter的使用以及解决中文乱码
- Perl 随笔
- 添加网页ico
- ICP(迭代最近点)算法
- Git入门详解
- jqeruy的append一个有趣的用法(挪移控件位置)
- Oracle 11g RAC使用Manual和Policy Managed方法配置(转)
- 【CSS Cookbook】笔记摘要(二)
- Django --- 单表的增删改查
- 使用@property
- [UE4]Spline使用注意事项
- 洛谷P2860 [USACO06JAN]冗余路径Redundant Paths(tarjan求边双联通分量)
- vsCode配置C++调试环境
- bzoj2152 (点分治)
- R语言编程艺术(5)R语言编程进阶
- 009.KVM配置调整
- [算法]谷歌笔试题:Beautiful Numbers
- GPS欺骗(一)—无人机的劫持
- Mysql安装(win10 64位)
热门文章
- 通过调用Windows本地RPC服务器bypass UAC
- CentOS 7 下安装 MySQL 5.7
- golang之格式化fmt.Printf
- HCIA SWITCHING&;ROUTTING 笔记——第一章 TCP/IP基础知识(2)
- Spring Boot 集成 Swagger生成接口文档
- Sping Aop日志实现(六)--日志查询功能
- Angular 学习笔记 immer 使用
- 偷窥篇:重要的C#语言特性——30分钟LINQ教程
- django.http.response中HttpResponse 子类
- EntityFramework进阶(四)- 实现批量新增