接口说明文档的生成（JavaDoc生成） 博客分类： 开发工具

1：如果开发团队需要web和service服务有不同工程师开发，约定参数的传递，并且以文档依据，比较好。

 

2：文档生成的样式

 

3：生成JavaDoc注释文档

（1）注释遵守JavaDoc的命名规范

 

（2）选中需要生成的文档的文件，上图。

     

      选中需要到处的文档注释文件或者工程

 

 

   选中工具Javadoc

 

矩形框标识的是生成的Javadoc文档的位置

 

 

此处可以自定义需要生成那些注释选项。

 

如果在JavaDoc生成过程中，出现乱码的情况，需要在此处配置。

 

4：在指定文件夹下查看，目录生成结构

 
 
点击index.html就会出现步骤2的注释文档，是不是很方便。