Java基础09 JavaDoc生成文档

JavaDoc生成文档

JavaDoc是什么?

javadoc是Sun公司提供的一个技术,它从程序 源代码 中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。 也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。

  • javadoc命令是用来生成自己API文档的

在这里插入图片描述

  • 参数信息
    1. @author 作者名
    2. @version 版本号
    3. @since 指明需要的最老的jdk版本
    4. @param 参数名
    5. @return 返回值情况
    6. @throws 异常抛出情况

深入了解JavaDoc

进入刚才编辑的java文件所在的文件夹

在这里插入图片描述

在文件夹内打开终端,用javadoc命令执行刚才编辑的java文件,UTF-8 -charset UTF-8是为了防止出现乱码,起美化作用的参数:

在这里插入图片描述

执行完后,可以发现原本空荡荡的文件夹内,出现了很多文件

在这里插入图片描述

其中有一个名为index.html的文件,这个文件就是我们javadoc的主要“工作成果”,打开index.html文件,就能看到一个展示了你刚刚编辑过的java文件的详细信息的网站:

在这里插入图片描述

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

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值