Scalaのcase classのフィールドにドキュメンテーションコメントが書けなくて悲しい
case classのフィールドを素朴に定義しました.
case class Book(
/** 一意な番号 */
var isbn: String)
これでフィールドにドキュメンテーションコメントが付けられると思ったのですが, これではつかないのですね.
コンストラクタのフィールドではなくclassのフィールドにして, コンストラクタ内で初期化すれば付きそうな気がしますが, ドキュメントのためにコードを冗長にはしたくないですね…
調べたのですが@paramを使ってnameを指定して書いていくしか無さそうですね.
Scaladoc | Style Guide | Scala Documentation
というか引数全般その様になっているようです.
2重にnameを書かないといけないのと,
Haskellだと普通に出来ていたことなので出来ないのは悲しみを抱いてしまいます.
その上これで生成は出来るのですが, scaladocドキュメント上にはValue Membersへの説明ではなく, あくまでコンストラクタの引数の説明として載ってしまいます.
フィールドそのものを生み出してるのですからそちらにも載せれば良いと思うのですが…
何か良い解決策は無いものですかね.
hatena-bookmark