使用IDEA与命令行生成JavaDoc文档

使用IDEA生成JavaDoc文档

JavaDoc是Sun公司提供的一种将注释生成HTML文档的技术,生成的HTML文档类似于Java的API。

  1. 生成JavaDoc文档之前,先简单介绍一下注释标签:

标记 说明 标签类型
@author 作者 作者标识 包、类、接口
@version 版本号 版本号 包、类、接口
@param 参数名 描述 方法的入参名及描述信息,如入参有特别要求,可在此注释。 构造函数、方法
@return 描述 对函数返回值的注释 方法
@deprecated 过期文本 标识随着程序版本的提升,当前API已经过期,仅为了保证兼容性依然存在.以此告之开发者不应再用这个API。 包、类、接口、值域、构造函数、方法
@throws 异常类名 构造函数或方法所会抛出的异常。 构造函数、方法
@exception 异常类名 同@throws 构造函数、方法
@see 引用 查看相关内容,如类,方法,变量等。 包、类、接口、值域、构造函数、方法
@si
  • 1
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值