在哪裏可以找到Scaladoc 2的教程？

Question

我對scaladoc 2.0教程或示例進行了binged或者google搜索，但我找不到任何東西，實際上甚至沒有鏈接到官方的scaladoc 2.0文檔。 任何人都知道在哪裏可以找到？

Answer 1

docs.scala-lang.org是「Scala社區驅動的文檔」的最新來源（感謝由Heather Miller提出的倡議）。
（由Martin Konicek編輯於David James的原版answer） Scaladoc page是相當新的。

Martin Konicek在評論中詢問如何製作簡單的Javadoc-like {@link}。
（而{@link}不scala.tools.nsc.ast.DocComments.scala提及）

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

---

初始答案（7月/ 2011年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

該Scala Style Guide有一個nice introductory page on scaladoc。我會推薦它在@ VonC的答案中提到的scala-lang.org wiki。

Answer 3

我在github上寫了一個Scaladoc HOWTO here。

這是一個如何與Scaladoc本身一起編寫，所以它作爲一個例子。我特別強調如何讓包文檔出現在您的API中，因爲這在官方文檔中並不十分清楚。

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 不支持[[鏈接]的方法（如的Javadoc的{@link type#instanceMethod(int, String)}或{@link type.staticMethod()}）。

Answer 5

這是我找到的最好的斯卡拉多指南：https://gist.github.com/VladUreche/8396624。這是降價的文字，所以下載它，並使用降價觀衆插件瀏覽器或將其粘貼到http://markdownlivepreview.com/讀它。