为什么写在方法上方的JavaDoc无法识别对应的@params参数?
JavaDoc参数无法识别排查方案
- 检查
@param注解拼写和格式:必须严格写为半角的@param,后面先跟方法的参数名,再跟描述内容,不要拼写成@params(多s),也不要把描述写在参数名前面 - 检查参数名匹配度:
@param后跟的参数名必须和方法定义的参数名完全一致,Java是大小写敏感的,比如方法参数为orderId时,@param orderid(小写i)无法被识别 - 检查IDE配置:如果是在IDEA/Eclipse等IDE中遇到识别问题,确认JavaDoc提示功能已开启,同时项目绑定的JDK配置正常无缺失
- 检查方法可见性配置:默认JavaDoc生成规则会忽略
private修饰的私有方法,如果需要识别私有方法的参数,需要手动调整JavaDoc生成/识别的可见性范围,开放私有方法的识别权限 - 检查非法字符:不要在
@param行混入中文全角空格、特殊符号,这类字符会打断IDE对参数名的解析,统一使用半角空格做分隔
对应问题效果截图:
内容的提问来源于stack exchange,提问作者Atomicglobe
相关产品推荐
相关产品推荐

