00014.06文档注解

最新推荐文章于 2023-04-20 17:36:07 发布

EP小良_007

最新推荐文章于 2023-04-20 17:36:07 发布

阅读量390

点赞数

分类专栏： javaSE

本文链接：https://blog.csdn.net/qq_41753340/article/details/108689288

版权

javaSE 专栏收录该内容

118 篇文章 1 订阅

订阅专栏

文章目录

一、文档注解是什么？
二、使用1 常用字段
三、使用2自动生成文档
总结

一、文档注解是什么？

文档注释相关的注解，是java当中特有的一种注释
在这里插入图片描述
其中 @author 是作者的意思，它读取了我们的计算机名

上面这些能够署上名的肯定是很优秀的程序员

二、使用1 常用字段

@autor 作者

@see 参考、引用

@since 从什么版本引入的

有些公司没有要求，必须加文档注释，但是也有一些非常规范的公司必须要求加上文档注释

先写方法，再写注释，会自动生成参数

@param：形参

格式：@param 形参名形参数据类型解释
要求：如果方法有几个形参就写几个@param
在这里插入图片描述

@return : 返回值

	格式：@return 返回值类型  解释
	要求：如果方法的返回值类型是void  就不用写了

@throws : 抛出的异常

	格式：@throws  异常类型名  解释
	要求：方法声明可能抛出几种异常就写几个，没有就不写
	【注意】@throw 也可以 也 @execetion

在这里插入图片描述

三、使用2自动生成文档

在这里插入图片描述

导出–> java --> java doc
在这里插入图片描述

如果没有自动定位，那么就点一下 conigu–> 手动定位到javadoc

在这里插入图片描述

可以自己生成文档，就可以不用打开源代码去看注释了
方便我们自己在公司内部的交流使用
正规的公司，或者团队较大的时，是有要求，要大家按这种要求来生成文档的，多人合作的时候非常方便

注意：有时候容易造成“最大的坑”即API上说的跟实际上不一样
这种情况往往是你代码改了，注释没跟着改，粗心了
所以注释你要么不写，要写就要时刻保持跟代码一致

总结