Idea JavaDoc注释|Java如何生成Doc文件|使用idea生成Doc文件|自制javaAPI

一、Java 写doc 注释，自制Java api

1.使用idea /** + 回车自动生成Doc注释模板

点击更多详细用法

2. 自制源码格式的 doc注释

1.第一行为会出现再索引的简介，很重要
2.必须空一行才能写具体操作
3.再空一行才能写各种标签 @param xxx…

具体可参考源码 ctrl + 鼠标左键

二、使用 cmd 生成 doc 文件

1.show in Explore 在文件夹中打开

2.打开命令行

3. 输入生成 Doc 的代码

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

4.点击打开生成的网页

二、使用idea生成doc

1.打开doc生成窗口

tool --> Gennerate Java

2.设置参数

我的设置

参数说明
1.Whole project:整个项目都生成文档
2.Custom scope 自定义范围。如下：
（1）project files 项目文件，
（2）project production files 项目产品文件，
（3）project test files 项目的测试文件， 未知范围，class hierarchy 类层
3.include test source 包含测试目录
4.include JDK and … 包含jdk和其他的第三方jar
5.link to JDK documentation…链接到JDK api
6.output directy 生成的文档存放的位置
（1）private、package、protected、public 生成文档的级别（类和方法）
（2）右边的Generate…是选择生成的文档包含的内容，层级树、导航、索引…
（3）再右边是生成的文档包含的内容信息，作者版本等信息
7.Locale 语言类型,zh-CN
8.Other command line arguments 其他参数
9.Maximum heep… 最大堆栈
作者：逝者如斯灬
链接：https://www.jianshu.com/p/0ddb0864e499
来源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出>>处。

注意：空白符错误，待解决

解决 ；方案地址点击跳转

1.问题：导出doc 报错

1.不要随便使用： {@code }等字符
2.不要随便使用使用 > 等字符

2.问题：导出doc无写的doc注释展示，介绍。

1.需要使用 Public private 等修饰符，不然无法导出该函数出去

实例