scala - scaladoc 中的逐字代码

Question

我有一个 Color companion 对象，它包含一些有用的颜色，我想按照以下方式记录它们:

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

您可能已经注意到，我想要的只是字符串 (.3, .3, .3, 1) 到在 Color 的文档中显示在 val darkGrey 的正下方。问题是Scaladoc 将第一个句点之前的所有内容都视为一个句子，并且之前的所有内容都隐藏在可扩展箭头的“内部”。那我呢get 是这样的:

这显然是不可取的。理想情况下，要么显示整个字符串否则整个字符串将被隐藏。有没有办法实现其中任何一个？

我也试过以下两种方法，都没有用。

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保存你的源代码，我想你也可以直接粘贴替代句点字符。