如何在scaladocs中链接另一个对象内部的变量

Question

要链接另一个类，我可以使用[[package.Classname]]。链接def定义的函数也可以，但尝试链接变量是行不通的。

我尝试过的：

object Foo {
val BAR = 0
}
object Example {
/**
* Does the thing with [[Foo.BAR]]
*/
def doTheThing(): Unit = {
}
}

我也尝试过[[Foo#BAR]](来自另一篇文章(而不是[[Foo.BAR]]，它也失败了。

在scaladoc中链接变量的正确方法是什么？

Answer 1

正确的方法是您已经尝试过的：

/**
* Does the thing with [[Foo.BAR]]
*/

请注意，如果这只是一个更复杂场景的示例，则需要包括Foo.BAR的整个包路径。例如，如果Foo处于：

package a.b.c.d

然后你需要做：

/**
* Does the thing with [[a.b.c.d.Foo.BAR]]
*/

您可以在scaladocs文档中找到：

使用方括号语法创建指向引用的Scala库类的链接，例如[[Scala.Option]]

有关更多信息，您可以阅读SCALADOC For LIBRARY AUTHORS

您可以在这里看到akka库是如何使用它的