smart-doc使用详细文档

1、controller类添加@RestController注解

2、controller类添加@RequestMapping注解

 主要用于结合smart-doc配置生成完整的接口URL，非必须

3、IDEA定义注释模板

3.1、定义类注释模板

3.1.1、File --> settings --> Editor --> File and Code Templates --> Includes --> File Header

3.1.2、配置类模板，将以下内容贴入”File Header“

/**
 * TODO 
 * @author: xxx
 * @description:  TODO 
 * @since：TODO 
 * @date:    ${DATE} ${TIME}
 */

        注：其中 第一行TODO、author、apiNote用于生成smart-doc文档

3.1.3、配置类模板中注解说明

注解	说明
第一行TODO	一句话简要说明类用处，torna的接口分类名称
@author	创建者，torna的维护人信息
@apiNote	类的详细描述信息
@since	最早出现在哪个版本，可以填版本号或日期
@date	类的创建时间

3.3、设置方法注释模板

3.3.1、File --> Settings --> Editor --> Live Templates

3.3.2、新建组：userDefine

 

3.3.3、新建模板命名为 *

 

3.3.4、配置方法注释模板

/**
 * TODO ${一句话说明接口功能}
 * @author: 创建者用户名
 * @description:  TODO 描述信息
 * @since：TODO 指明最早出现在哪个版本，可填版本号或日期
 * @date:    ${DATE} ${TIME}
 */

3.3.5、注释模板中参数配置

参数名	配置	skip if define
$end$		√
$param$	groovyScript("if("${_1}".length() == 2) {return '';} else {def result=''; def params="${_1}".replaceAll('[\\[\	\\]&#124;\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(i==0){result+='* @param ' + params[i] + ': '}else{result+='\n' + ' * @param ' + params[i] + ': '}}; return result;}", methodParameters());
$return$	groovyScript("def returnType = "${_1}"; def result = '* @return: ' + returnType; return result;", methodReturnType());	√
$date$	date()	√
$time$	time()	√

3.3.6、勾选下面两项的复选框

Reformat according to style

shorten FQ names

3.3.7、设置生成注释的快捷键为 Tab

3.3.8、使用

        创建方法后，在方法上方输入 /* 再按Tab键即可自动生成方法配置

4、发布接口文档到torna

        maven --> project_name --> plugins --> smart --> doc --> smart-doc:torna-rest