《JAVA之如何部署javadoc》

前言：

       我希望我的希望不再是希望

正文：

      javadoc-who

        javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。即只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过javadoc就可以同时形成程序的开发文档了。

       javadoc命令是用来生成自己API文档的，使用方式：使用命令在目标文件所在目录输入javadoc+文件名.java

 部署javadoc具体步骤

        一。在项目中添加javadoc插件的引用

       二。 找到Jenkins构建的job,定位apidoc的位置

       web层-------（/var/lib/jenkins/workspace/itoo-achieve-dev-52/achievement-web/target/apidocs）

       service层----（/var/lib/jenkins/workspace/itoo-achieve-dev-52/achievement-service/target/apidocs） 

       api层---------（/var/lib/jenkins/workspace/itoo-achieve-dev-52/achievement-api/target/apidocs）

     三。完善该job的配置

    

     四。编辑nginx配置文件，添加apidoc的配置

location /api/auth-api {
     root /usr/local;
     index index.html;               
}

     五。在本公司项目中，服务有多个，继而创建一个html索引页，建立统一入口，如图所示：

备注：web层也可以用javadoc生成注释文档，但在公司项目中web层用的是swagger-ui，继而部署的是swagger-ui

结语：

       脚踏实地，岁月该给你的，会在岁月中悄然送给你。