要链接另一个类，我可以使用[[package.Classname]]。链接由定义的函数def也可以，但是尝试链接变量不起作用。
我尝试过的
object Foo {
val BAR = 0
}
object Example {
/**
* Does the thing with [[Foo.BAR]]
*/
def doTheThing(): Unit = {
}
}
我还尝试了[[Foo#BAR]]（从另一篇文章中）来代替[[Foo.BAR]]，它也失败了。
在scaladoc中链接变量的正确方法是什么？
正确的方法是您已经尝试过的方法：
/**
* 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库如何使用它。
本文收集自互联网，转载请注明来源。
如有侵权，请联系[email protected] 删除。
我来说两句