如果我理解正确的话,方法的 Scaladoc 应该自动继承它覆盖的父方法的 Scaladoc。这似乎适用于一组本地类,但在从 Scala 的标准库(可能还有任何外部依赖项?)扩展时则不然。
class LocalParent {
/**
* some documentation
*/
def foo = ???
}
class DocumentedChild extends LocalParent
class UndocumentedChild extends Iterator[Int] {
def hasNext = ???
def next = ???
}
有没有办法继承Scaladoc?或者我做错了什么?
另外,我正在使用sbt doc
,所以不scaladoc
直接地。
这是我使用的(SBT 0.13):
scalacOptions in (Compile, doc) ++=
Seq("-diagrams",
"-diagrams-max-classes",
"20",
"-external-urls:java=http://docs.oracle.com/javase/6/docs/api/," +
"scala=http://www.scala-lang.org/api/current/")
附录 1:
为了解决在重写方法时对标准库类进行子类化并希望重写方法的文档注释的问题,可以使用继承文档标记来注释成员:
/** @inheritdoc */
override def foo(bar: String): Int = bar.length
附录2:
此功能的更现代形式记录在此 SBT 0.13 文档页面 http://www.scala-sbt.org/0.13.2/docs/Howto/scaladoc.html.
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)