Install Scala on your computer and start writing some Scala code!
Scaladoc¶ 全てのパッケージ,クラス,トレイト,メソッド,その他のメンバにドキュメントを提供することはとても重要です。Scaladocは一般にJavadocの慣習に従いますが,記述を簡潔にすませるための機能が多数追加されています。 普通は,書式よりもその内容や書き方を気にしたいと思います。Scaladocは経験豊富なユーザと同様に初心者にも便利で無くてはなりません。この目的を達成する方法はとても単純です。すなわち,説明の詳細度を上げて,簡明な要約から始め(熟達したユーザの参考として有益です),詳細部ではより丁寧な例(熟練者は無視するかもしれませんが,初心者には何よりも貴重なものです)を提供することです。 Scaladocの一般的な書式は次の様なものです。 /** * これは何を説明しようとしているかの簡潔な記述です。 * * これは我々がドキュメント化しようとしているものを更に記述
ScaladocではWikiスタイルの記法がサポートされているのでHTMLではなくWiki記法を使うのがいいらしい。 http://d.hatena.ne.jp/kiyoshihosoda/20101209 http://www.scala-lang.org/node/4285 http://yanana.github.com/scala-style/scaladoc/index.html こんな感じ。 /** This is a paragraph * * This is another paragraph (note the empty line above) containing '''bold''', * ''italic'', `monospace`, * __underline__, ^superscript^, and ,,subscript,, words. * * {{{
Scaladoc 2 Scaladoc 2 improves overs previous versions of Scaladoc with: A sleeker, more modern interface; Improved comment syntax that help writing documentation for complex libraries: support for wiki-like syntax in the source comments, improved comment inheritance, compile-time checking of documentation errors, advanced commenting constructs, such as use cases and macro definitions; A new API f
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く