Question

我为scaladoc 2.0教程或示例进行了bin或google搜索，我找不到任何东西，实际上甚至没有链接到官方scaladoc 2.0文档。谁知道在哪里找到一个？

Answer 1

docs.scala-lang.org是“社区驱动的Scala文档”的最新来源（感谢Heather Miller提出的倡议）。
（由Martin Konicek原David James answer编辑。 Scaladoc page是最新的。

Martin Konicek在评论中询问如何制作简单的Javadoc {@link}。
（scala.tools.nsc.ast.DocComments.scala）

中未提及{@link}

他提到Scaladoc使用[[fullyQualifiedName]]代替{@link}。

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

目前，我对Scaladoc2了解的最完整的信息来源是新的 scala-lang.org Wiki 。

David James在评论中提及Syntax page和Tags and Annotations。

author page 包含示例，包括what's new section：

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

Answer 2

我在github here上写了一个Scaladoc HOWTO。

这是一个用Scaladoc本身编写的方法，因此它就是一个例子。我特别强调如何在您的API中显示包文档，因为这在官方文档中并不十分清楚。

Answer 3

Scala Style Guide有一个nice introductory page on 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()}）。< / p>

Answer 5

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

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

5 个答案: