如何在scaladoc中引用Object类中的val的名称？

Question

有没有办法可以使用scaladoc在Object类中引用val的名称,类似于

{@value #STATIC_FIELD} 

在javadoc.

Answer 1

你可以通过两种方式做到这一点：

package your.package_path


object SomeObject extends App {

  val someList: List[Int] = List.empty[Int]

  /**
   * @see [[your.package_path.SomeObject#someList]]
   * @see [[someList]]
   * ...
   */
  def bar(): String = ???
}