无法识别注释中@param的内容
binzhou75 opened this issue · comments
是 get 请求的 param 参数么
/**
* 获取工作组所属观测点信息,非树状结构,便于表格展示
* @param batchid - 批次ID
* @param groupid - 工作组ID
* @param currentUser - 当前用户
* @return - 表格结构的观测点信息
*/
@RequestMapping(value = "/flatindicators",method = RequestMethod.GET)
public NicResult GetFlatIndicators(@RequestParam String batchid,
@RequestParam String groupid,
@currentuser PersonVo currentUser){
return igroupService.GetFlatIndicators(batchid,groupid,currentUser);
}
以上面的代码为例,接口方法中的参数在注释中有描述性的信息,但是生成的md文档中没有这些信息;
在idea中,任何函数的参数在/**/注释里,可以用@param 列出,并增加描述信息,希望在生成md文档时,直接获取这些描述信息;
另外,生成的md文档中参数列表(- param 下的表格)中,参数名前面会有一个null,还是以上面代码为例,生成的md为:
- Param
参数名 | 类型 | 必选 | 描述 |
---|---|---|---|
nullbatchid | String | Y | |
nullgroupid | String | Y |
我的idea版本是 212.5080.55
已经修复