idea生成JavaDoc文档
今天在学习java基础时,想用idea创建JavaDoc,找了很多资料,总结了怎么创建JavaDoc。后面还有idea报
javadoc: 错误 - java.lang.IllegalArgumentException
时,解决的办法。
1.参数说明
参数说明参考
作者:逝者如斯灬
链接:https://www.jianshu.com/p/0ddb0864e499
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 区域设置
8.Other command line arguments 其它命令行参数
9.Maximum heep… 最大堆栈
我这里的配置如下:
2.Locale(区域设置),这个决定了文档的语言
zh-CN
3.在 “Tools->Gerenate JavaDoc” 面版的 “Other command line arguments(其它命令行参数):” 栏里输入以下参数防止乱码
-encoding UTF-8 -charset UTF-8 -windowtitle "文档标题可自定义" -link http://docs.Oracle.com/javase/7/docs/api
是环境配置里面CLASSPATH中字符冲突引起的,把CLASSPATH里的%JAVA_HOME%\lib改成绝对路径,就可以了。
我的路径是以下这样,你们根据自己的路径修改就行了。
C:\Program Files\Java\jdk1.8.0_241\bin\dt.jar;
C:\Program Files\Java\jdk1.8.0_241\bin\tools.jar