Scaladocの記法

Scala

ScaladocではWikiスタイルの記法がサポートされているのでHTMLではなくWiki記法を使うのがいいらしい。

こんな感じ。

/** This is a paragraph
*
* This is another paragraph (note the empty line above) containing '''bold''',
* ''italic'', `monospace`,
* __underline__, ^superscript^, and ,,subscript,, words.
*
* {{{
* Multi-line code can be inserted as a block and will be printed as monospace
* text.
* It isn't parsed as Scala, with keyword highlighting, but may be in the
* future.
* }}}
*
* In the near future, wiki syntax will also support bullet or number lists as
* well as links to the www and to other pages inside the documentation. */

パラメータとかはJavadoc同様、@paramみたいなタグで記述するようです。サポートされているタグは以下の通り。

  • @author (複数可)
  • @see (複数可)
  • @return (1つだけ)
  • @throws (例外ごとに1つだけ)
  • @param (パラメータごとに1つだけ)
  • @tparam (型パラメータごとに1つだけ)
  • @version (1つだけ)
  • @since (1つだけ)
  • @todo (複数可)
  • @deprecated (複数可)

Wiki記法については上記のリンク先には簡単なサンプルしかないけどちゃんとしたドキュメントはないのかな…。