IEDA内JavaDoc的使用与常见问题

javadoc

javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在
编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。
**javadoc命令是用来生成自己API文档的**，使用方式：使用命令行在目标文件所在目录输入javadoc +文件名.java。

环境配置

常见问题及其解决

​ 很多小伙伴在配完java的jdk环境后没有配置CLASSPATH后报javac、javadoc不是内部命令

以下是如何配置

JAVA_HOME 指向的是JDK的安装路径，如C:\Program Files\Java\jdk1.8  那么系统环境变量中就要配置
1.JAVA_HOME  =C:\Program Files\Java\jdk1.8
2.PATH       =%JAVA_HOME%\bin;
3.CLASSPATH  =.;%JAVA_HOME%\lib;%JAVA_HOME%\lib\tools.jar

首先要注意的是最前面的".;"，这个是告诉JDK，搜索CLASS时先查找当前目录的CLASS文件——为什么这样搞，这是由于LINUX的安全机制引起的，LINUX用户很明白，WINDOWS用户就很难理解(因为WINDOWS默认的搜索顺序是先搜索当前目录的，再搜索系统目录的，再搜索PATH环境变量设定的) 。
为什么CLASSPATH后面指定了tools.jar这个具体文件？不指定行不行？显然不行，行的话我还能这么罗索嘛！😃 这个是由java语言的import机制和jar机制决定的，你可以查资料解决。

具体的设定方法: 右键点击我的电脑->属性->高级->环境变量，修改下面系统变量那个框里的值就行了。

参考地址：JAVA环境变量JAVA_HOME、CLASSPATH、PATH设置详解

验证

java -version 没有正确配置CLASSPATH不一定代表配置成功，javac有可能无效
javac
javadoc

javadoc在IDEA上的使用

1. IDEA 的 JavaDoc 生成功能在菜单 Tools->Generate JavaDoc 项里面。
   ​
   

2.“Generate JavaDoc scope” 选项是指生成 JavaDoc 的源代码对象的选择一般以模块（Module）为主，必要时可以单独选择必要的 Java 源代码文件，不推荐以 PRoject 为 JavaDoc 生成的源范围。

3.“Locale:” 可选填项表示的是需要生成的 JavaDoc 以何种语言版本展示，我么写上zh_CN,这样生成的 JavaDoc 就是中文版本的，当然指的是 JavaDoc 的框架中各种通用的固定显示区域都是中文的。你自己编写的注释转换的内容还是根据你注释的内容来。

4."Output directory:是指你生成的javadoc在那个文件夹下，需你自己设置

5"Other command line arguments:" 可选填项非常重要，写如下参数

-encoding UTF-8 -charset UTF-8 -windowtitle "接口wiki" -link http://docs.Oracle.com/javase/7/docs/api


//第一个参数 -encoding UTF-8 表示你的源代码是基于 UTF-8 编码的，以免处理过程中出现中文等非英语字符乱码
//第二个参数 -charset UTF-8 表示在处理并生成 JavaDoc 超文本时使用的字符集也是以 UTF-8 为编码，目前所有浏览器都支持 UTF-8，这样最具有通用性，支持中文非常好；
//第三个参数 -windowtitle 表示生成的 JavaDoc 超文本在浏览器中打开时，浏览器窗口标题栏显示的文字内容；
//第四个参数 -link 很重要，它表示你生成的 JavaDoc 中涉及到很多对其他外部 Java 类的引用，是使用全限定名称还是带有超链接的短名称

6.JavaDoc 生成完毕，即可在你第4部设置的文件夹下找到 index.html 文件，打开它就可以看到我们自己的标准 JavaDoc API 文档啦。

参考地址：JavaDoc的使用