我如何 link scaladocs 中另一个对象中的变量？

Question

给link另一个class，我可以用[[package.Classname]]。 def 定义的链接函数也可以，但尝试 link 变量不起作用。

我尝试过的：

object Foo {

  val BAR = 0
}

object Example {

  /**
  * Does the thing with [[Foo.BAR]]
  */
  def doTheThing(): Unit = {

  }
}

我也试过 [[Foo#BAR]]（来自另一个 post）而不是 [[Foo.BAR]]，但也失败了。

scaladoc 中 link 变量的正确方法是什么？

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 中找到 docs:

Create links to referenced Scala Library classes using the square-bracket syntax, e.g. [[scala.Option]]

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

您可以查看 here 以及 akka 库如何使用它的示例。

How do I link variables inside another object in scaladocs?