如何在 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查看该库如何使用它的示例。