scala - 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，我想您也可以直接粘贴替代句点字符。