文章目录
- 一、前言
- 二、IDEA生成API的步骤
- 1、Tools->Genearte javaDoc
- 2、设置
- 1、参数解释:
- 2、生成文档
- 3、文档结构如下：
一、前言
javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。
javadoc命令是用来生成自己API文档的，使用方式：使用命令行在目标文件所在目录输入javadoc +文件名.java。
二、IDEA生成API的步骤
1、Tools->Genearte javaDoc
2、设置
1、参数解释:
- locale:zh_CN：表示生成中文文档
- encoding UTF-8:源代码使用UTF-8编码
- charset UTF-8:表示生成的文本字符集使用UTF-8编码
- windowtitle “title”:表示用浏览器打开时的窗口标题
2、生成文档
3、文档结构如下：
打开index.html即可查看生成的API
