scala - 为什么scaladoc方法签名错误？

Question

Scala API中有很多地方，特别是在集合中，方法签名是错误的。

例如，Map的 scaladoc 签名。flatMap说

def flatMap[B](f: (A) ⇒ GenTraversableOnce[B]): Map[B]

但实际签名是

flatMap[B, That](f: ((A, B)) ⇒ GenTraversableOnce[B])
    (implicit bf: CanBuildFrom[Map[A, B], B, That]): That

这个特别没有意义，因为 scaladoc 签名包括Map[B], 但Map有两个类型参数，而不是一个。

这里发生了什么？这是一个错误吗？

score 13 · Accepted Answer

您在生成的文档中看到的不正确签名称为“用例”。他们应该通过显示理想化的 API 来澄清文档，类似于真实的 API，但省略了繁琐的细节（比如困扰某些人 CanBuildFrom的普遍隐式参数）。

对于带有用例的方法，您可以通过单击方法名称以显示该方法的详细信息，然后单击“完整签名”以展开另一个显示签名的部分来获取真正的签名。

Scala 问题 SI-3448创建于 2010 年 5 月，专门处理为Map. 此问题已于 2012 年 7 月以“无法修复”的形式关闭。
Paul Phillips 的演讲Scala 集合：为什么不呢？从 2014 年 1 月开始，在幻灯片 1、幻灯片 2、幻灯片 3中将用例视为“谎言” 。
在GenTraversableLike.scala 中，您可以看到导致生成用例文档的指令示例：
```
@usecase def flatMap[B](f: A => TraversableOnce[B]): $Coll[B]
```

1 回答 1