scala - 为什么 Scaladoc 方法签名是错误的？-6ren

scala - 为什么 Scaladoc 方法签名是错误的？

转载作者：行者123 更新时间：2023-12-03 16:54:19

27

4

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有两个类型参数，不是一个。

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

最佳答案

您在生成的文档中看到的错误签名称为“用例”。他们应该通过展示理想化的 API 来澄清文档，类似于真实的 API，但省略了繁琐的细节(比如普遍存在的隐式 CanBuildFrom 参数 bothers some people)。

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

引用

Scala issue SI-3448 ，创建于 2010 年 5 月，专门处理为 Map 显示的错误数量的类型参数.此问题已于 2012 年 7 月关闭“不会修复”。

保罗·菲利普斯的演讲 Scala Collections: Why Not?从 2014 年 1 月开始，在 slide 1 中 mock 用例为“谎言” , slide 2 , slide 3 .

在 GenTraversableLike.scala您可以看到导致生成用例文档的指令示例:

@usecase def flatMap[B](f: A => TraversableOnce[B]): $Coll[B]

类似问题

Why does the scaladoc say HashMap.toArray returns Array[A] instead of Array[(A,B)]?

The List :: method and covariance ... why do they hide the real signature?

scaladoc for map on Map ... is the documentation wrong, or am I missing something?

What's going on here with scala.collection.immutable.Stack.+: (prepend)? ...

Why do some method descriptions in Scaladoc start with [use case]?

How to explain Map.map result

关于scala - 为什么 Scaladoc 方法签名是错误的？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/26132459/

27

4

0

文章推荐： sails.js - 缩小所有的sails.js 提供的html

文章推荐： xpath - hive -横向 View explode xpath

文章推荐： xpath - 带有节点列表的 Apache Camel XPath

Ruby 方法() 方法
我想了解 Ruby 方法 methods() 是如何工作的。我尝试使用“ruby 方法”在 Google 上搜索，但这不是我需要的。我也看过 ruby-doc.org，但我没有找到这种方法。
VBS教程：方法-Test 方法
Test 方法对指定的字符串执行一个正则表达式搜索，并返回一个 Boolean 值指示是否找到匹配的模式。 object.Test(string) 参数 object 必选项。总是一个
VBS教程：方法-Replace 方法
Replace 方法替换在正则表达式查找中找到的文本。 object.Replace(string1, string2) 参数 object 必选项。总是一个 RegExp 对象的名称。
VBS教程：方法-Raise 方法
Raise 方法生成运行时错误 object.Raise(number, source, description, helpfile, helpcontext) 参数 object 应为
VBS教程：方法-Execute 方法
Execute 方法对指定的字符串执行正则表达式搜索。 object.Execute(string) 参数 object 必选项。总是一个 RegExp 对象的名称。 string
VBS教程：方法-Clear 方法
Clear 方法清除 Err 对象的所有属性设置。 object.Clear object 应为 Err 对象的名称。说明在错误处理后，使用 Clear 显式地清除 Err 对象。此
VBS教程：方法-CopyFile 方法
CopyFile 方法将一个或多个文件从某位置复制到另一位置。 object.CopyFile source, destination[, overwrite] 参数 object 必选
VBS教程：方法-Copy 方法
Copy 方法将指定的文件或文件夹从某位置复制到另一位置。 object.Copy destination[, overwrite] 参数 object 必选项。应为 File 或 F
VBS教程：方法-Close 方法
Close 方法关闭打开的 TextStream 文件。 object.Close object 应为 TextStream 对象的名称。说明下面例子举例说明如何使用 Close 方
VBS教程：方法-BuildPath 方法
BuildPath 方法向现有路径后添加名称。 object.BuildPath(path, name) 参数 object 必选项。应为 FileSystemObject 对象的名称
VBS教程：方法-GetFolder 方法
GetFolder 方法返回与指定的路径中某文件夹相应的 Folder 对象。 object.GetFolder(folderspec) 参数 object 必选项。应为 FileSy
VBS教程：方法-GetFileName 方法
GetFileName 方法返回指定路径（不是指定驱动器路径部分）的最后一个文件或文件夹。 object.GetFileName(pathspec) 参数 object 必选项。应为
VBS教程：方法-GetFile 方法
GetFile 方法返回与指定路径中某文件相应的 File 对象。 object.GetFile(filespec) 参数 object 必选项。应为 FileSystemObject
VBS教程：方法-GetExtensionName 方法
GetExtensionName 方法返回字符串，该字符串包含路径最后一个组成部分的扩展名。 object.GetExtensionName(path) 参数 object 必选项。应
VBS教程：方法-GetDriveName 方法
GetDriveName 方法返回包含指定路径中驱动器名的字符串。 object.GetDriveName(path) 参数 object 必选项。应为 FileSystemObjec
VBS教程：方法-GetDrive 方法
GetDrive 方法返回与指定的路径中驱动器相对应的 Drive 对象。 object.GetDrive drivespec 参数 object 必选项。应为 FileSystemO
VBS教程：方法-GetBaseName 方法
GetBaseName 方法返回字符串，其中包含文件的基本名 (不带扩展名), 或者提供的路径说明中的文件夹。 object.GetBaseName(path) 参数 object 必
VBS教程：方法-GetAbsolutePathName 方法
GetAbsolutePathName 方法从提供的指定路径中返回完整且含义明确的路径。 object.GetAbsolutePathName(pathspec) 参数 object
VBS教程：方法-FolderExists 方法
FolderExists 方法如果指定的文件夹存在，则返回 True；否则返回 False。 object.FolderExists(folderspec) 参数 object 必选项
VBS教程：方法-FileExists 方法
FileExists 方法如果指定的文件存在返回 True；否则返回 False。 object.FileExists(filespec) 参数 object 必选项。应为 FileS

首页

博学

6Ren·AI

商城

scala - 为什么 Scaladoc 方法签名是错误的？