Question

很抱歉，如果这是一个愚蠢的问题，但我只是坚持如何最好地记录这个类型的课程。

我最近开始在Scala工作，正在努力清理一些代码并添加文档。

我的项目中有一个API，可以向其他服务提出请求。 API并将该服务API的响应转换为我项目API的未来结果。

样本结构：

object RequestClient {
    def Request(method: String, path: String, queryString: String, body: String = ""): Future[Result] = {
        // Do work here
        return Future[Result]
    }
}

我正在尝试将Request方法记录如下：

/**
  * Returns [[scala.concurrent.future]] of Response to Some service's API.
  */

但似乎这只会引用未来的类而不提及它特别是Result类型的Future []。

这似乎是一个重要的细节，这是一个结果类型（与Int String或其他东西相对），但如果我将其指定为：

/**
  * Returns [[play.api.mvc.Result]] of Response to Some service's API.
  */

然后它失去了对它是未来[结果]的事实的引用。

似乎可以做这样的事情，但它有一种气味。

/**
  * Returns [[scala.concurrent.future]] `[` [[play.api.mvc.Result]] `]` of Response to Some service's API.
  */

有任何建议，或者我只是运气不好，需要选一个？

提前感谢您的帮助。

**更新

为了澄清我希望得到的内容如下：

未来[结果]

单击Future文本将链接到scala.concurrent.future的文档，单击Result文本将链接到play.api.mvc.Result的文档

Answer 1

如果我理解了你想要的内容，一个包含自定义文字的链接，你可以使用一个有效的空格链接，然后是你的文字：

* Returns [[scala.concurrent.future play.api.mvc.Result]]

编辑：

重新阅读这个问题，我的回答并不是你想要的。我认为你的解决方案是正确的。

如何在ScalaDoc文档（版本2.10.6）中引用类型化类

1 个答案: