【Java】生成JavaDoc(API)文档

本文档介绍了如何使用IntelliJ IDEA(IDEA)和命令行(CMD)生成Java API文档。在IDEA中,通过Tools菜单的Generate JavaDoc选项,指定输出目录并设置中文编码,即可生成文档。在CMD中,通过javadoc命令指定编码格式和源文件,文档将在源代码目录下生成。生成的JavaDoc文件主要包含API接口和类的详细说明,方便开发者查阅。
摘要由CSDN通过智能技术生成

一、IDEA生成Javadoc文档

 

  1. 首先新建一个文件夹,用来专门存放JavaDoc文档

  2. 打开idea选择要生成文档的代码

     3. idea的顶部有一个Tools的菜单,选择Generate JavaDoc这个选项

       4. 然后在Output directory 输入框后面的按钮点击进去选择我们刚才创建的文件夹

      5. 然后在下面的locale框中输入zh_CN,这个代表的就是中文,输完之后在下面的框中输入这行编码

-encoding utf-8 -charset utf-8

       6. 最后点击ok就行了,等待文件生成完毕之后,我们打开JavaDoc文件夹可以看到生成了很多文件,只需要打开index.htmlL文件,进去之后就能看到生成的API文档了

二、cmd窗口生成Javadoc文档

  1. 打开需要生成文档的代码文件夹,然后直接在上方地址栏前输入cmd就会直接进入该目录dos窗口

     2.进入dos之后输入……加上自己要生成文档文件的名称Test02.java文件,

编码格式: Javadoc 参数 Java文件 

javadoc -encoding UTF-8 -charset UTF-8 Test02.java

3. 回车,就会完成生成,这个是直接生成在代码文件夹下的,最后点击index.html就能进去看             生成的API文档了

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值