Javadoc:使用@link链接到接口的描述

时间:2014-01-09 03:46:44

标签: hyperlink javadoc

我是一名技术作家,正在编辑我们的开发人员编写的Javadoc评论。其中一条评论就像是

/**
 * Lorem ipsum dolor sit amet. 
 * {@link SomeInterface}
 */

当提交给Jenkins时,构建失败并出现“未解析的链接/看到标记”之类的错误,因此我做了以下更改:

/**
 * Lorem ipsum dolor sit amet. 
 * {@link com.example.foo.SomeInterface}
 */

我认为这样可以解决问题(更改为完全限定的接口名称),但它仍然失败并显示相同的错误消息。

在阅读http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#link时,第一句话说

Inserts an in-line link with visible text label that points to the documentation
for the specified package, class or member name of a referenced class.

具体说“引用类”,不包括“接口”。我如何@link到公共接口的描述?

0 个答案:

没有答案