Scaladoc吞下了@throws和@note标签

时间:2011-09-13 07:42:17

标签: scala scaladoc

在创建Scala文档时,我还使用@throws@note标记,例如记录的here (Scaladoc Wiki - Tags and Annotations)

不幸的是,我在生成的 Scaladoc 中找不到这些。

是否必须设置某些开关,考虑具体的事情或这是一个已知问题?

顺便说一句:使用Scala 2.9.0.1的scaladoc Ant任务也不会发出警告。

编辑: BTW2并澄清:我不是指@throws注释

@throws(classOf[RuntimeException])
def dispatch: Nothing = throw new RuntimeException

在此def的注释部分中记录,但Scaladoc的@throws标记如

/** @throws RuntimeException
 */
def dispatch: Nothing = throw new RuntimeException

2 个答案:

答案 0 :(得分:3)

这是一个bug和尚未成为发行版的东西的组合。

@note不起作用,这是一个已知错误,请参阅@todo, @note and @example don't work?

@throws最近才添加,请参阅2011年7月合并的pull request Simon Ochsenreither。这尚未发布,2011年5月发布2.9.0.1 ,2.9.1于2011年7月开始。

答案 1 :(得分:3)

半年前我added support for @note

如果你看一下,它似乎工作正常:scala.util.matching.Regex

其他内容是@throws ScalaDoc标记。实际上我正在考虑删除对它的支持,而支持@throws注释,这是受支持的,因为我看不到任何用例更喜欢ScalaDoc标记到注释的用例。

如果您有真正需要,请告诉我,不要让我知道!

编辑:Mhhh。看看scala.Array它实际上看起来就像是另一种方式......