javaWeb文档自动生成

  javaWeb文档对一个公司的重要性，这里就不说了，有工作经验且想在这个行业走下去的程序猿都深有体会，至于它存在的好处也是多的数不胜数，多余的话不多说了，下面介绍一下本人最近了解的几种能自动生成api的方法。

   当然也是本人百度搜出来的，首先网上有很多关于swagger的传说，多的真是眼花缭乱，既然这么流程，当然本人也按捺不住自己的好奇心，就亲自集成了一下，由于本人在公司开发用的框架是springMvc，当然是用springMvc集成swagger了，过程有点烦乱，几经波折终于实验成功了，觉得还挺好用，但是原始的界面本人不太满意，所以网上各种搜索，看看有没有关于页面美化或是改造的文档说明，答案当然是没有了，心凉了一半。这时不知道脑子怎么短路了，竟然想到开发工具也有自动生成文档的功能，于是又是百度各种搜索，功夫不负有心人，自己试验了一把，又成功了，这次的结果总算满意了，哈哈 ~~~

  其实网上关于集成自动生成的api的方法除了swagger，还有几种，这里就不说了，百度搜应该有很多的，就说一下比较流程的swagger，swagger集成到spring需要有相应的依赖jar包和配置还要有特定的swagger-ui页面做支撑，而且swagger的依赖还要和swagger-ui页面的版本配套才行，本人就是因为这个问题，搞了一周多才实验成功了，觉得很坑 ~ 

swagger API文档生成需要在controller入参中写相应的注解，初次看感觉有点乱，把正常的业务入参搞的眼花缭乱的，当然它也有很多的好处，生成的api列表信息很清楚，然后可以在页面调用接口，感谢大神提供这样的神器；

   首次就要说开发工具自动生成api的方法，其实很简单，在注释中用注解，然后就可以一键生成api了,下面介绍一下常用的注解和生成api的方法:

   常用注解:

@author 标明开发该类模块的作者 
@version 标明该类模块的版本 
@see 参考转向，也就是相关主题 
@param 对方法中某参数的说明 
@return 对方法返回值的说明 
@exception 对方法可能抛出的异常进行说明 

 生成方法(这里介绍intellij IDEA):

 tools -> generate JavaDoc ->  other command line arguments中输入-encoding utf-8 -charset utf-8(解决乱码) -> Ok

 然后一个美丽的javaDoc就生成了 ~

 以上都是自己一些看法，有什么不对的地方，请各位多多指教 ~