scaladoc 2のチュートリアルはどこにありますか？

Question

私はscadadoc 2.0のチュートリアルや例のためにbingしたりグーグルグーグしていましたが、実際には公式のscaladoc 2.0のドキュメントへのリンクさえありませんでした。 誰にどこを見つけるか知っていますか？

Answer 1

docs.scala-lang.orgは、最近の「Scalaのコミュニティ指向のドキュメント」（Heather Millerによる主導のおかげで）です。
（Martin KonicekのDavid Jamesのオリジナルanswerで編集されました） Scaladoc pageは最新です。

Martin Konicekは、簡単なJavadocのようにする方法をコメントで尋ねます{@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は、Tracで使用されているのと非常によく似たwikiのような構文をサポートしています。
Scaladocの作者は、HTML以外の形式の文書も生成する可能性があるため、一般的にScaladocの作者はHTMLタグを使用しないでください。

Answer 2

Scala Style Guideは、nice introductory page on scaladocを有する。 @ VonCの答えに述べられているscala-lang.org wikiをお勧めします。

Answer 3

私はgithub hereにScaladoc HOWTOを書いています。

Scaladoc自体で書かれたハウツーで、例として役立ちます。公式のドキュメントではあまり明確ではないので、あなたのAPIにパッケージドキュメントを表示する方法を重視しました。

Answer 4

凝縮フル例：Scaladoc 2.9 は（Javadocのの{@link type#instanceMethod(int, String)}又は{@link type.staticMethod()}等）方法に[リンク]をサポートしていないことを

/** 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) = {} 
} 

注意。

Answer 5

これは私が見つけたScaladocのベストガイドです：https://gist.github.com/VladUreche/8396624です。これはマークダウンテキストなので、ダウンロードしてブラウザ用のmarkdown viewerプラグインを使用するか、http://markdownlivepreview.com/に貼り付けて読んでください。