1、场景描述

使用IDEA（本次使用2017.3版）将自己写的常用的工具类打成jar包，安装到maven本地仓库，最后生成对应的doc参考文档。
原工程截图如下。

2、打jar包

• 执行 File => Project Structure =>Artifacts =>点击+号 =>JAR =>Empty，弹出如下对话框。
  
• 执行 Build => Build artifacts => generated-order-number-1.0 => Build，会在之前指定的路径下生成对应名字的jar包。

3、安装jar包到本地仓库

• 为方便操作，将上一步生成的jar包放到D盘根目录下。
• cmd窗口执行如下命令即可。

mvn install:install-file -DgroupId=util "-DartifactId=generated-order-number" "-Dversion=1.0" "-Dpackaging=jar" "-Dfi
le=D:\generated-order-number-1.0.jar"

注意1：之后在maven项目中第一次导入对应的坐标前，可能需要先执行 File=> Settings=> 搜索Repositories=> 选择本地仓库索引的URL进行update操作。
注意2：如果源代码本身构建的就是maven项目，则可以直接使用maven的生命周期命令 package 和 install 直接进行打包和安装。

4、生成JavaDoc文档

执行 Tools=> Generate JavaDoc=> 弹出下面的对话框，填写相关配置信息后确定即可。

部分参数说明如下。

locale: zh_CN ：表示生成的是中文文档
-encoding UTF-8 ：表示源代码使用UTF-8编码
-charset UTF-8 ：表示生成的文本字符集使用UTF-8编码
windowtitle “生成订单号接口文档” ：表示用浏览器打开时的窗口标题
-link https://docs.oracle.com/javase/8/docs/api/ ：表示生成的文档中使用到的原JDK的类是一个短链接，点击可以跳转到JDK官方文档。

文档打开效果如下。

5、番外

安装到maven本地仓库的jar包，如果我不想要了，直接删除后，并不会完全删除干净，会有一些残留文件。那么如何清理其中的lastUpdate、error文件夹和无效jar包呢？

使用bat批处理文件解决。新建txt文档，保存如下代码。将MAVEN_REPOSITORY_PATH的值改为自己的maven仓库地址。然后文件扩展名改为 .bat，双击执行即可。

set MAVEN_REPOSITORY_PATH=D:\JavaIDE\maven\maven-repository
rem searching now...
for /f "delims=" %%i in ('dir /b /s "%MAVEN_REPOSITORY_PATH%\*lastUpdated*"') do (
    del /s /q %%i
)
for /f "delims=" %%i in ('dir /b /s "%MAVEN_REPOSITORY_PATH%\*unknown*"') do (
    rmdir /s /q %%i
)
rem clean success
pause