摘要
在使用Intellij IDEA对项目代码审查的时候, 发现在Javadoc issues部分报出了3个errors, 点击查看时并解决过程如下.
问题1: Cannot resolve symbol 'http'
目的是想在调用的地方, 鼠标悬停时, 显示超链接, 点击可进入目标网站, 开始的写法是直接在 @see 后面加上URL地址, 结果就报出了如下错误: This inspection points out unresolved references inside javadoc(图1)
图1
查询文档后才意识到, 这种点击直达的链接需要加上<a>标签
即: @see <a href="http://redis.io/commands/incr">redis incr</a>
问题2: '@param redisKey' tag description is missing
看了下面详细的描述后, 通过排除, 基本确定是因为这个参数没有注释导致的, 为redisKey添加注释描述后, 发现警告消失了(图2)
@param redisKey redis的key值
图2
最终结果(图3):
鼠标悬停时, 显示redisKey值的注释
超链接变为了蓝色, 鼠标移动上去时会变成手状, 点击后链接到期望的网址
图3
网友评论