Scala 2.10中Scaladoc中添加了哪些新功能(或将会添加)?

时间:2012-07-06 04:38:32

标签: scala documentation scaladoc

在进入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]]那样显而易见 - 即我绝对不需要给出一个绝对的类(一旦我拿出一个类并将其粘贴在其他地方就会使一切都破坏),我不应该如果方法名称本身是明确的(即非多态的),则需要给出参数类型。

1 个答案:

答案 0 :(得分:18)

有几个新功能,以及许多错误修正,但是还没有确定的所有修复列表。其中一些值得注意的新功能:

  • 现在可以看到隐式添加的成员。一个很好的例子是查看scala.Array,您可能认为自己拥有的map等方法现在可以在Scaladoc中看到。
  • 自动生成的SVG继承图,用于鸟瞰包级别的类/特征/对象之间的关系,然后也可以在各个类的级别等。例如,请参阅Scaladoc每晚都会在package-level(点击“内容层次结构”)以及class-level上绘制图表。
  • 方法链接以某种有限的形式应该进入2.10(不在夜间)。 (正如你所指出的那样,由于像重载这样的实际问题,以完整的形式实现并不是完全无足轻重的。)
  • 改进用例具有用例的成员不再生成,现在它们比以前更清晰,更简单。
  • (不太引人注目)用于导航Scaladoc的键盘快捷键已添加,它们已解释为herehere

对于更详尽的错误修正列表,写入scala-internals可能是一个好主意 - 很可能有人会在那里编译过去一年中所有主要错误修正的列表。