注释规范

## 注释规范
### 1.添加类注释

------------

![](/media/202405/2024-05-07_172143_278889.png)

```
/**
 * ${type_name}
 *
 * @author hzl
 * @date ${date}
 */
```

### 2.添加方法注释

![](/media/202405/2024-05-07_172303_443659.png)

```
/**
 * showdoc
 * 
 * @catalog 开发规范/注释规范（目录）
 * @title 方法标题
 * @description 方法描述
 * @method get/post/instance/static(可写具体调用代码)
 * @url www.demo.com
 * @param strValue 必选 String 参数一
 * @param intValue 必选 Integer 参数二
 * @return {"sucess":false,"message":"错误信息"}
 * @return_param sucess boolean 是否成功
 * @return_param message string 错误信息
 * @remark 方法备注
 * @number 99
 */
```

- @注解说明

| 注解名称          | 说明          | 值规范                                                       | 描述                               |
|---------------|-------------|-----------------------------------------------------------|----------------------------------|
| showdoc       | 自动导出Api标记   | showdoc                                                   | 选填, 默认导出                         |
| @catalog      | 导出目录/分隔     | 业务分类(大类)/类中文｜ClassName                                    | 必填, 标准2级                         |
| @title        | 方法标题        | -                                                         | 必填                               |
| @description  | 方法描述        | -                                                         | 选填, 建议填写                         |
| @method       | 请求方式        | get, post, instance, static【DateFunc.format(format,date)】 | 必填, instance实例调用, static具体静态调用示例 |
| @url          | 请求地址        | url, insc.method(…), Class.method(…)                      | 必填, 地址，Java调用示例                  |
| @param        | 方法参数,可定义多个  | 参数名 是否必选 类型 说明                                            | strValue [必填，选填] String 说明1      |
| @return       | 返回值定义       | Json,JavaObject                                           | 必填                               |
| @return_param | 返回参数对象key说明 | 参数名 类型 说明                                                 | 选填 sucess boolean 是否成功           |
| @remark       | 方法备注        | -                                                         | 选填                               |
| @number       | 方法导出文件排序优选级 | 整数                                                        | 从小到大排序,默认99                      |