JavaDoc生成文档

1. JavaDoc命令用来生成自己的API文档

(1)JavaJDK8内置帮助文档网址:https://docs.oracle.com/javase/8/docs/api/
在这里插入图片描述
(2)生成文档注释:/**+回车

(3)类的文档注释(加在类上面):
在这里插入图片描述
(4)方法的文档注释(加在方法上面):
在这里插入图片描述

2.cmd生成JavaDoc文档

(1)在文件夹中打开:右键Doc类 > Open In > Explorer
在这里插入图片描述
在这里插入图片描述
(2)在资源管理器的地址栏中打开cmd,方法详见之前的博客【打开cmd的四种方式】。用javadoc生成帮助文档:
在这里插入图片描述
按Enter键后,生成很多html:
在这里插入图片描述
(3)回到文件夹,发现多了很多的.html文件,双击index.html,生成了类似JavaJDK8内置帮助文档的内容:
在这里插入图片描述
生成的html文档:
在这里插入图片描述

3.IDEA生成JavaDoc文档(参考博客【使用IDEA生成JavaDoc文档(IDEA2020.3.2)】)

(1)【Tools】–【Generate JavaDoc】
在这里插入图片描述
(2)生成JavaDoc
在这里插入图片描述
① 选择生成JavaDoc文档的范围,我只对源文件生成Doc,所以选择文件
② 输出目录最好新建一个文件夹,更具条理和整洁性
③ 区域设置,决定文档的语言,简体中文就是zh_CN、繁体(台湾)zh_tw、繁体(香港)zh-hk、英语(香港)en-hk、英语(美国)en-us、英语(英国)en-gb、英语(全球)en-ww
④ 如果区域设置为中国,参数一般为-encoding UTF-8 -charset UTF-8,防止中文乱码

(3)查看JavaDoc文档
打开上一步设置的输出目录,可看到成功生成,打开 index.html 便能看生成的文档。
在这里插入图片描述
在这里插入图片描述

  • 3
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值