Javadoc:使用{@link}可以避免package-info中的完全限定名称

时间:2015-01-27 20:28:32

标签: javadoc

package-info.java添加文档时,我无法找到避免在{@link}条评论中使用完全限定名称的方法。拥有完全限定的名称使得文档在未格式化的注释和格式化输出中的可读性更低。 import不起作用,因为我们在package-info.java有其他人遇到此问题并找到了解决方案,或者在使用{{1}时我们只需要在package-info.java中使用完全有资格的名称}}

1 个答案:

答案 0 :(得分:3)

链接后,添加要显示的文本。例如:

{@link com.company.whatever Whatever}

应显示为Whatever

Javadoc Reference Guide中记录了这一点。