showdoc自动生成文档步骤

一、适用场景

目前只支持eclipse。

二、安装过程

将打包好的插件放在\eclipse\dropins\目录下，重启eclipse。
eclipse的工具类中会多出如下图标，就说明安装成功。

image.png

三、使用过程

1. 第一步：在controller方法页面点击插件图标，会出现如下画面中的弹框
   注意：如果不在controller方法页面点击会提示错误
   

   image.png

2. 第二步：点击登录showdoc按钮，服务器填写http://192.168.88.47，账号密码填写showdoc的账号密码

3. 第三步：双击最上方controller，会弹出以下窗口，选择这个controller所属的菜单。要是没有所需要的菜单，可以点击新增菜单或者修改菜单对菜单添加或修改菜单。选择完菜单后点击保存按钮。

   
   image.png

4. 第四步：双击列表中具体的接口，并填写接口的标题（就是showdoc接口的名称）

   
   image.png

5. 第五步：双击接口下的方法参数，会显示该接口的入参

6. 第六步：双击接口的入参。会弹出配置入口参数的窗口，可以对参数进行范围，示例和说明等更改，如下图

   image.png
   如果该参数为单个意义的参数，则直接添加说明即可；
   如果该参数为String类型的Json字符串，则点击类型后的按钮，选择这个json字符串对应的实体类，（需要注意的是该对应的实体类必须为打开状态【就是在文件目录下双击】）如下；
   image.png
   7.第七步：先选中接口，然后点击“保存当前方法到showdoc”按钮，会显示保存成功提示，showdoc上就会产生相应的文档。 image.png