为接口生成javadoc(eclipse)

1、先配置注释样式

(1)项目右键-》properties

为接口生成javadoc(eclipse)_第1张图片

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

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

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


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

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

3、export javadoc文档

项目或者java方法右键-》export
为接口生成javadoc(eclipse)_第2张图片

通过修改生成位置,可以让文档生成到服务器启动可以访问的位置,方便别人查看api,调用接口
为接口生成javadoc(eclipse)_第3张图片 为接口生成javadoc(eclipse)_第4张图片
输入-encoding UTF-8 -charset UTF-8防止中文乱码

为接口生成javadoc(eclipse)_第5张图片

4、生成结果

为接口生成javadoc(eclipse)_第6张图片

你可能感兴趣的:(java,安装)