在Scaladoc中，如何链接到同一个类中的方法？

Question

在同一个类中创建指向方法的链接的正确方法是什么？ Scaladoc documentation没有这方面的例子。

考虑如下的课程：

package controllers

// import ...

class AccountController extends Controller with Secured {

  def current = Authenticated() { request =>
    // ...
  }

  /**
   * See [[current]] for an endpoint that...
   */
  def findAll = Authenticated() { request =>
     // ... 
  }

}

在IntelliJ IDEA的“快速文档”弹出窗口中，所有这些都显示为红色：

• [[current]]
• [[#current]]
• [[AccountController.current]]
• [[AccountController#current]]
• [[controllers.AccountController.current]]

这确实显示为蓝色：

[[controllers.AccountController#current]]

所以我认为这是正确的，但有没有更简单但更正确的方法？

Answer 1

您的示例的正确方法是：

[[controllers.AccountController#current()]]

对于不带参数的函数，此处需要空括号，尽管您不应该在代码中添加这些。您还必须在所有地方使用完全限定的名称，这意味着它应该包含程序包，类名称，＃标签和方法名称。

Answer 2

我不确定它何时修复，但我使用的是 IntelliJ IDEA 2020.3 版，它对我有用：

/**
 * See [[current]] for an endpoint that...
 */