在package-info.java中使用JavaDoc的导入

时间:2013-11-24 04:53:15

标签: java javadoc

在我正在记录的软件包的JavaDoc中(具体来说,在package-info.java文件中),我有许多看起来像{@link some.really.long.module.ClassName}的行,我自然想要导入ClassName并代之以{@link ClassName},但我尝试过的任何作品都没有。这甚至可能吗?

我已经尝试将导入放在包声明和JavaDoc之上,但是这显示了语法错误。我已经尝试将导入放在包声明和JavaDoc下面,但是JavaDoc进程会警告Tag @link: reference not found: ClassName

2 个答案:

答案 0 :(得分:0)

只需在package-info文档中使用完全限定名称即可。 JavaDoc将生成HTML而不显示完全限定名称(至少在1.7中),因此结果应该看起来很好。打字会更烦人。

答案 1 :(得分:0)

你可以这样做:

This class {@linkplain some.really.long.module.ClassName ClassName} does bla bla bla...

这将显示为

  

这个班级ClassName确实是bla bla bla ...