java文档注释---Javadoc的用法

前言
Java中有三种注释方式。前两种分别是 // 和 /* /,主要用于代码的注释,以此来方便代码的可读性。第三种被称作说明注释或文档注释,它以 /* 开始,以 /结束,文档注释允许你在程序中嵌入关于程序的信息,有了这个注释就可以使用 javadoc 工具软件来生成信息,并输出到HTML文件中。
2.文档注释的格式
/
*
*…
/
之后,你可以包含一个或多个各种各样的 @ 标签。每一个 @ 标签必须在一个新行的开始或者在一行的开始紧跟星号(
),其中常用的标签如下(详细标签请参考http://www.runoob.com/java/java-documentation.html):

标签 描述 示例
@author 标识一个类的作者 @author description
@version 指定类的版本 @version info
@param 说明一个方法的参数 @param parameter-name explanation
@return 说明返回值类型 @return explanation

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值