如何在IntelliJ中查看Scala文档

时间:2016-03-25 09:47:11

标签: scala intellij-idea documentation

我正在尝试学习Scala,我对Java有很多经验。通常,当我想知道有关类或函数的信息时,我会查看源代码及其javadoc。

不幸的是,当我打开Scala的Stream类文件时,它看起来像这样:

abstract class Stream[+A]() extends scala.collection.AbstractSeq[A] with scala.collection.immutable.LinearSeq[A] with scala.collection.generic.GenericTraversableTemplate[A, scala.collection.immutable.Stream] with scala.collection.LinearSeqOptimized[A, scala.collection.immutable.Stream[A]] with scala.Serializable {
 this : scala.collection.immutable.Stream[A] =>
  override def companion : scala.collection.generic.GenericCompanion[scala.collection.immutable.Stream] = { /* compiled code */ }
  def isEmpty : scala.Boolean
  def head : A
  def tail : scala.collection.immutable.Stream[A]
  protected def tailDefined : scala.Boolean
  def append[B >: A](rest : => scala.collection.TraversableOnce[B]) : scala.collection.immutable.Stream[B] = { /* compiled code */ }
  def force : scala.collection.immutable.Stream[A] = { /* compiled code */ }
  def print() : scala.Unit = { /* compiled code */ }
  def print(sep : scala.Predef.String) : scala.Unit = { /* compiled code */ }
  override def length : scala.Int = { /* compiled code */ }
  override def toStream : scala.collection.immutable.Stream[A] = { /* compiled code */ }
  override def hasDefiniteSize : scala.Boolean = { /* compiled code */ }
  //... and much more...

我是否使用没有文档的Scala版本?功能是否被认为是如此隐含,以至于它不需要解释?或者我应该总是访问他们的网站进行文档记录?这里浮现出这些问题。但是,我感兴趣的主要是:

使用IntelliJ中的Scala快速查找类和函数文档的最方便的方法是什么?

1 个答案:

答案 0 :(得分:2)

添加到新项目

这是最简单的方法。

  

档案 - >新 - >项目...... - > [LHS列表中的Scala] - > [RHS列表中的SBT] - > [下一步按钮]

您现在应该进入“新建项目”对话框。在这里,您应该看到一个“下载”部分,其中包含“来源”复选框。您可以勾选此内容以下载完整的源代码,包括文档。然后,当你按照你所做的那样提出定义时(使用CMD + B),你应该看到代码以及任何文档。

enter image description here

添加到现有项目

如果要添加到现有项目。这更复杂,取决于您使用的IDEA版本。对于IDEA 14和Scala 2.11.7:

  

档案 - >项目结构...... - >全球图书馆 - > [LHS上的Scala] - > [加号]

并为来源添加以下内容:

  

[回家之路] / .ivy2 / cache / org.scala-lang / scala-library / srcs / scala-library-2.11.7-sources.jar

和JavaDocs:

  

[回家路径] /。ivy2 / cache / org.scala-lang / scala-library / docs / scala-library-2.11.7-javadoc.jar