idea java文档的注解说明与自动生成

一、idea关于java类上的文档注释生成

类注释文档是随着java文件创建而创建的。

截图来自以下csdn
https://blog.csdn.net/qq_34581118/article/details/78409782
在这里插入图片描述
在这里插入图片描述

二、 idea关于java方法上的文档注释生成

(1) 使用 / + a + tab 三个组合键。
(2) 可以在方法外面使用上面的组合键有效。

截图来自以下csdn https://blog.csdn.net/qq_34581118/article/details/78409782

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

三、 javadoc的相关注解

写在类上面的JavaDoc

写在类上的文档标注一般分为三段:

  • 第一段内容:概要描述,通常用一句或者一段话简要描述该类的作用,以英文句号作为结束。
  • 第二段内容:详细描述,通常用一段或者多段话来详细描述该类的作用,一般每段话都是以英文句号作为结束。
  • 第三段内容:文档注解,用于标注作者,创建时间,jdk版本支持等。

在这里插入图片描述

写在方法上面的JavaDoc

  • 第一段内容:概要描述,通常用一句或者一段话简要描述该类的作用,以英文句号作为结束。
  • 第二段内容:详细描述,通常用一段或者多段话来详细描述该类的作用,一般每段话都是以英文句号作为结束。
  • 第三段内容:文档标注,用于标注参数,返回值,异常,参阅等。
    方法详细描述上经常使用html标签,通常都以p标签开始,而且p标签通常都是单标签,不使用结束标签,其中使用最多的就是p标签和pre标签,ul标签, i标签。

pre标签可定义预格式化的文本。被包围在pre标签中的文本通常会保留空格和换行符。而文本也会呈现为等宽字体,pre标签的一个常见应用就是用来表示计算机的源代码。

一般p经常结合pre使用,或者pre结合@code共同使用(推荐@code方式)
在这里插入图片描述

四、 idea生成javadoc文档

  • 点击tools,然后generate javadoc
    在这里插入图片描述
  • 配置参数
    local: zh_CN
    line arguments: -encoding UTF-8 -charset UTF-8 -windowtitle 测试使用javaDoc
    在这里插入图片描述

五、java文档注解说明

参考链接:https://blog.csdn.net/lsy0903/article/details/89893934

  • p结合pre使用, 用在详细描述中的代码使用举例
  • pre结合@code使用,用在详细描述中的代码使用举例
  • @param注解
    • @param 函数参数名 参数描述
  • @return注解
    • @return 返回值描述
  • @throws注解
    • @throws 异常类型 异常类型描述,用于描述方法内部可能抛出的异常。
  • @exception注解
    • @exception 用于描述方法签名throws对应的异常
  • @deprecated注解
    • @deprecated 用于描述一个类或者成员方法已经过期,经常配合{@link}使用
  • @see注解
    • @see既可以用于类也可以用于方法,表示可以参考的类或者方法
  • @value注解
    • {@value}用于标注在常量上用于表示常量的值
  • 4
    点赞
  • 9
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值