scala - Scala 2.10 中将(或将要)添加哪些新功能到 Scaladoc?

标签 scala documentation scaladoc

关闭。这个问题需要更多focused .它目前不接受答案。












想改善这个问题吗?更新问题,使其仅关注一个问题 editing this post .

3年前关闭。




Improve this question




在进入 Scala 2.10 的各种不完整的特性列表中,有各种提到对 Scaladoc 的改进。但目前还不清楚有哪些,哪些实际上正在进入——例如改进列表之一说“对 Scaladoc 的修复”,其中包含指向各种拉取请求的链接,其中一些请求被拒绝。

谁能总结一下 Scala 2.9 和 2.10 里程碑 4 之间实际发生的变化,并指出 2.10 本身还有什么计划?

另外,他们最终会解决无法链接到方法的问题吗?例如。散落在我的代码中,我有这样的事情:

/**
 * Reverse the encoding computed using `encode_ngram`.
 */
def decode_ngram(ngram: String): Iterable[String] = {
  DistDocument.decode_ngram_for_counts_field(ngram)
}

我想在同一个类中引用另一个方法,但 AFAIK 根本没有办法做到这一点。 IMO 应该很明显,例如 [[encode_ngram]] - 即我绝对不需要给出绝对类(一旦我拉出一个类并将其粘贴到其他地方,这会使一切都崩溃),并且如果方法名称,我不应该需要给出参数类型本身是明确的(即非多态的)。

最佳答案

一些新功能以及许多错误修正即将推出,但目前还没有所有修正的明确列表。比较显着的新功能:

  • 隐式添加的成员现在将可见 .一个很好的例子是查看 scala.Array , 其中方法如 map您可能已经假设您现在可以在 Scaladoc 中看到它。
  • 自动生成的SVG继承图 , 鸟瞰包级别的类/特征/对象之间的关系,然后也是单个类的级别等。例如,请参阅 package-level 每晚的 Scaladoc 图。 (单击“内容层次结构”)以及 class-level .
  • 方法链接以某种有限的形式应该进入 2.10(不是在夜间)。 (正如您所指出的,由于重载等实际问题,以完整的形式实现实际上并非易事。)
  • 改进的用例 不再重复生成具有用例的成员,而且它们现在比以前更清晰、更简单。
  • (不太显眼)键盘快捷键 已添加用于导航 Scaladoc,对它们进行了解释 herehere

  • 要获得更详尽的错误修正列表,写信给 scala-internals 可能是个好主意——很有可能有人会在那里为您编译过去一年中所有主要错误修正的列表。

    关于scala - Scala 2.10 中将(或将要)添加哪些新功能到 Scaladoc?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/11355923/

    相关文章:

    css - React 生成的文档(.md 文件)并将自定义样式传递给组件内的元素

    php - 您如何记录您的内联 PHP 函数和类?

    scala - 在 SBT 中覆盖自动 API 映射

    IntelliJ 中的 Scala 文档

    string - 如何将 "y"/"n"列映射到 Scala 的 Slick 中的 boolean 值?

    scala - 在 Scala 中定义类型安全的可选方法的最佳方法是什么?

    java - 维护 Java 应用程序的多种形式的用户指南

    scala - 如何使用 Scaladoc 生成类型层次结构图?

    scala - SBT,<<= 和 := 之间的区别

    scala - 将参数标记为隐含在方法中