3

いくつかの有用な色を保持する Color コンパニオン オブジェクトがあり、次の方法でそれらを文書化したいと思います。

object Color {
  /** (.3, .3, .3, 1) */
  val darkGrey = Color(.3, .3, .3, 1);
}

お気づきかもしれませんが、必要なのは、 のドキュメントの(.3, .3, .3, 1)すぐ下に文字列が表示されるようにすることだけです。問題は、Scaladoc が最初のピリオドより前のすべてを文と見なし、それより前のすべてが展開可能な矢印の「内側」に隠されていることです。だから私が得るのは次のようなものです:val darkGreyColor

ここに画像の説明を入力

これは明らかに望ましくありません。理想的には、文字列全体が表示されるか、文字列全体が非表示になります。これらのいずれかを達成する方法はありますか?

また、次の 2 つの方法も試しましたが、いずれも機能しません。

object Color {
  /**
    * (.3, .3, .3, 1)
    */
  val darkGrey = Color(.3, .3, .3, 1);
}
object Color {
  /** {{{
    * (.3, .3, .3, 1)
    * }}}
    */
  val darkGrey = Color(.3, .3, .3, 1);
}   
object Color {
  /** ` (.3, .3, .3, 1) ` */
  val darkGrey = Color(.3, .3, .3, 1);
}
4

1 に答える 1

5

期間の検出は scaladoc の後期段階にあるようです。どのように生成またはエスケープされたかは問題ではありません。私が見つけた唯一の解決策は、少し奇抜です。ピリオドを避ける必要があります。別の Unicode を使用します。

/** @define dot \u2024 */
object Color {
  /** `(${dot}3, ${dot}3, ${dot}3, 1)` */
  val darkGrey = Color(.3, .3, .3, 1);
}
case class Color(r:Double,g:Double,b:Double,alpha:Double)

ソースコードを UTF-8 で保存した場合、代替ピリオド文字を直接貼り付けることもできると思います。

于 2012-06-19T00:41:43.600 に答える