如何让scaladoc显示默认参数值?

时间:2013-03-16 09:40:59

标签: scala default-value scala-2.10 default-parameters scaladoc

我有很多方法,比如

def foo(..., ..., runFinalizer: Boolean = true)
         (implicit finalizer: Finalizer): Result = ...

但是当我运行scaladoc(使用sbt)时,它没有记录runFinalizer具有默认值。这是非常有问题的,因为用户很少将参数设置为false,并且生成的文档不会显示它可以省略。

到目前为止,我有两个完全令人满意的解决方案:

  1. 记录runFinalizer块内可以省略@param的事实。它有所帮助,但导致在文档中的许多地方重复这样的句子,并且用户可能会忽略它。
  2. 创建方法的两个变体,一个带runFinalizers(没有默认值),另一个没有。但这会不必要地增加方法的数量,并使代码和文档混乱。

1 个答案:

答案 0 :(得分:0)

这很可能是一个错误,仅在某些情况下发生:SI-4922 Omitted default argument values 。我升级到Scala 2.10.1。它工作正常。