为接口生成javadoc(eclipse)

1、先配置注释样式

(1)项目右键-》properties

(2)点击edit即可对注释进行编辑

eg:

Types:

/**
* <b>描述:</b>
* <br><b>作者:</b> ***
* <br><b>版本:</b>v2.0
* <br><b>ProjectName:</b> ${project_name}
* <br><b>PackageName:</b> ${package_name}
* <br><b>ClassName:</b> ${type_name}
* <br><b>Date:</b> ${date} ${time}
*/

Methods:

	/**
	 * <b>描述:</b><br>
	 * <b>HTTP Method:</b> GET <br>
	 * <b>接口地址:</b>
     * ${tags} <br>
	 * "remarks": "No remarks" <br>
	 * "returnReason": "OK" 成功 <br>
	 * "returnStatus": 200 返回成功 <br>
	 * "returnTotal":  returnInformation的个数 <br>
	 * "returnInformation": <br>
	 *             { <br>
	 *             } <br>
	 *  <b>Author:</b>*** <br>
	 * <b>Date:</b> ${date} ${time}
	 */

2、代码中选中class名或者method名，快捷键ctrl+shift+j进行注释

对相应的参数加上自己的注释

3、export javadoc文档

项目或者java方法右键-》export

通过修改生成位置，可以让文档生成到服务器启动可以访问的位置，方便别人查看api，调用接口

输入-encoding UTF-8 -charset UTF-8防止中文乱码

4、生成结果