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

Question

私はscaladoc2.0のチュートリアルや例を探したり、グーグルで検索したりしましたが、何も見つかりませんでした。実際、scaladoc2.0の公式ドキュメントへのリンクすら見つかりませんでした。どこにあるか知っている人はいますか？

Answer 1

docs.scala-lang.orgは、「Scalaのコミュニティ主導のドキュメント」の最新のソースです（Heather Millerが主導するイニシアチブに感謝します）。
（DavidJamesの元の回答でMartinKonicekが編集したように）Scaladocページは非常に最新です。

Martin Konicekはコメントで、単純なJavadocのようなものを作成する方法を尋ねてい{@link}ます。
（そして、 {@link}で言及されていませんscala.tools.nsc.ast.DocComments.scala）

彼は、Scaladocが[[fullyQualifiedName]]の代わりにを使用すると述べています{@link}。

---

最初の回答（2011年7月/ 9月）

現在、Scaladoc2について私が知っている最も完全な情報源は、新しいscala-lang.orgWikiにあります。

David Jamesは、コメントの中で構文ページとタグと注釈について言及しています。

著者ページには、新機能セクションなどの例があります。

ドキュメントの作成者は、コメントにHTMLタグを使用する必要がなくなりました。
代わりに、Scaladocは、 Tracで使用されているものと非常によく似たwikiのような構文をサポートしています。
一般に、Scaladocの作成者はドキュメントでHTMLタグを使用しないでください。これは、Scaladocが将来HTML以外の形式でドキュメントを生成する可能性があるためです。

Answer 2

ここでgithubにScaladocHOWTOを書きました。

これはScaladoc自体を使用して作成されたハウツーなので、例として役立ちます。パッケージのドキュメントをAPIに表示する方法に特に重点を置きました。これは、公式のドキュメントではあまり明確ではないためです。

Answer 3

Scalaスタイルガイドには、scaladocに関する優れた紹介ページがあります。@VonCの回答で言及されているscala-lang.orgwikiよりもお勧めします。

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や）への[[links]]をサポートしていないことに注意してください。{@link type#instanceMethod(int, String)}{@link type.staticMethod()}

Answer 5

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