javadoc使用介绍

2019独角兽企业重金招聘Python工程师标准>>>

最近在接手一个项目，项目使用了框架集成，所产生的类会很多。在熟悉框架和项目的过程中，就想着把框架的功能分模块进行归类，然后进行记录，方便以后对项目问题的排查，也方便以后同事的接手。所以呢，就想着使用javadoc生成类的api。

以前使用过javadoc，但是时间有一点长了，所以感觉很生疏，这次再次使用，百度了很多次在才使用畅通，记录一下，以备不时之需。

首先，javadoc并不是内部命令，使用之前呢需要先安装JDK并配置环境变量，这个呢很简单，在这里就不记录了，百度一大堆。

javadoc最简单的使用方式就是：

javadoc -d ‘api的文件目录’xx.java

对xx.java生成api文档，放在‘api的文件目录’中，如果是多个java文件，源文件用空格隔开：

javadoc -d ‘api的文件目录’xx.java xx2.java xx3.java

如果在当前目录有多个java文件的话，也可以是*代替java文件的名字

javadoc -d ‘api的文件目录’*.java

有些时候呢，我们可能要针对目录去生成API，相对目录这块，我遇到了一个特别蛋疼的问题，就是我在生成api目录的上级目录去敲的命令，导致的一个问题就是一直提示 ** 错误 - 找不到可以文档化的公共或受保护的类**。所以在针对目录生成api的时候，在src目录下操作，这样的话在有关联关系的时候会容易找到：

../src :  javadoc -d "doc目录" -encoding utf-8 -subpackages com.xx.xx   看好，是.  不是/    ，这里写的是相对路径，

如果写绝对路径的话，命令如下

../src :  javadoc -d "doc目录" -encoding utf-8 -sourcepath d:\...src com.xx.xx

几个常用参数说明：

-d 
指定api生成的位置  (文件夹）
-encoding 
指定你的源文件的字符编码（utf-8）
-charset 
指定生成api的字符集（utf-8）
-sourcepath 
指定源代码路径，默认是当前目录。 此参数通常是必须的。
-subpackages 
以递归的方式处理各子包。关键参数！如果不使用本参数，每次只能处理一个子包（或需手工列出所有子包）。

转载于:https://my.oschina.net/xuyuqiang/blog/2251945