scala - 在哪里可以找到 scaladoc 2 的教程？

Question

我搜索或搜索 scaladoc 2.0 教程或示例，我找不到任何东西，实际上甚至没有指向官方 scaladoc 2.0 文档的链接。有人知道在哪里可以找到吗？

Answer 1

docs.scala-lang.org是“Scala 的社区驱动文档”的更新来源（感谢Heather Miller领导的倡议）。
（由Martin Konicek在David James的原始答案中编辑）Scaladoc 页面是最新的。

Martin Konicek在评论中询问如何制作一个简单的类似 Javadoc 的{@link}.
（并且 {@link}未在 中提及scala.tools.nsc.ast.DocComments.scala）

他提到 Scaladoc 使用[[fullyQualifiedName]]而不是{@link}.

---

初步答案（2011 年 7 月/2011 年 9 月）

目前，我所知道的关于 Scaladoc2 的最完整信息来源是新的scala-lang.org Wiki。

David James在评论中提到了语法页面，以及标签和注释。

作者页面有示例，包括新增功能部分：

文档的作者不再需要在他们的评论中使用 HTML 标签。
相反，Scaladoc 支持类似于 wiki 的语法，与 Trac 中使用的语法非常相似。
一般来说，Scaladoc 作者不应再在文档中使用 HTML 标签，因为 Scaladoc 将来可能还会生成除 HTML 之外的其他格式的文档。

Answer 2

我在这里的 github 上写了一个 Scaladoc HOWTO 。

这是使用 Scaladoc 本身编写的操作指南，因此可以作为示例。我特别强调了如何让包文档显示在您的 API 中，因为这在官方文档中不是很清楚。

Answer 3

Scala Style Guide在scaladoc 上有一个很好的介绍页面。我会在@VonC 的回答中提到的 scala-lang.org wiki 上推荐它。

Answer 4

一个精简的完整示例：

/** Creates [[mypackage.Person]] instances, taking a `String` argument. */
object Person {
  /** Create a [[mypackage.Person]] with a given name.
  *
  * This is another paragraph (note the empty line above) containing '''bold''',
  * ''italic'', `monospace`, __underline__, ^superscript^, and ,,subscript,,.
  * 
  * Example:
  * {{{
  * val person = Person("Bill")
  * }}}
  *
  * @param name their name
  * @return a new Person instance
  */
  def apply(name: String) = {}
}

请注意，Scaladoc 2.9不支持 [[links]] 到方法（如Javadoc或）。{@link type#instanceMethod(int, String)}{@link type.staticMethod()}

Answer 5

这是我找到的最好的 Scaladoc 指南：https ://gist.github.com/VladUreche/8396624 。它是 Markdown 文本，因此请下载并使用浏览器的 Markdown 查看器插件或将其粘贴到http://markdownlivepreview.com/以阅读。