Hyperlink Javadoc:使用@link链接到接口的描述
我是一名技术作家,正在编辑我们的开发人员编写的Javadoc注释。其中一条评论是这样的Hyperlink Javadoc:使用@link链接到接口的描述,hyperlink,javadoc,Hyperlink,Javadoc,我是一名技术作家,正在编辑我们的开发人员编写的Javadoc注释。其中一条评论是这样的 /** * Lorem ipsum dolor sit amet. * {@link SomeInterface} */ 提交给Jenkins时,构建失败,出现了“未解析链接/查看标记”之类的错误,因此我做了以下更改: /** * Lorem ipsum dolor sit amet. * {@link com.example.foo.SomeInterface} */ 我原以为这会解决问
/**
* Lorem ipsum dolor sit amet.
* {@link SomeInterface}
*/
提交给Jenkins时,构建失败,出现了“未解析链接/查看标记”之类的错误,因此我做了以下更改:
/**
* Lorem ipsum dolor sit amet.
* {@link com.example.foo.SomeInterface}
*/
我原以为这会解决问题(更改为完全限定的接口名),但仍然失败,并显示相同的错误消息
在读第一句时说
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.
其中明确表示“引用类”,不包括“接口”。我如何@链接到公共接口的描述?我认为这些说明中的“类”并不排除接口。尝试链接到同一个包中的另一个类,可以吗?另一个子包(比如com.example.other.ClassName)中的一个类如何?是的,在同一个包中已经有另一个指向不同类的@link,并且它不会生成错误消息。我不想问这个问题,但是接口是否真的存在于同一个目录中,即JavaDoc正在查找的目录中?尝试链接到同一软件包中的其他界面。谢谢您的帮助。我们已经确定了原因,这是特定于我们的项目设置。