scaladoc中的逐字代码

Question

我有一个Color伴侣对象,它包含一些有用的颜色,我想以下列方式记录它们:

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

你可能已经注意到了,我想要的只是字符串(.3, .3, .3, 1)出现val darkGrey在文档的正下方Color.问题是Scaladoc在第一个时期之前将所有内容都作为一个句子,之前的所有内容都隐藏在可扩展箭头的"内部".所以我得到的是这样的:

这显然是不受欢迎的.理想情况下,要么显示整个字符串,要么隐藏整个字符串.有没有办法实现其中任何一个？

我也尝试了以下两种方法,但没有一种方法可行.

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);
}

Answer 1

似乎周期检测处于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,我猜您也可以直接粘贴替代句点字符.