如何继承KDoc文档?

时间:2016-03-03 15:41:39

标签: javadoc kotlin kdoc kotlin-dokka

在Java的Javadoc中,有一种方法可以使用{@inheritDoc} tag在子类中继承方法的文档。

有没有办法在Kotlin的KDoc中做同样的事情?

基本上,我想做的是以下内容:

abstract class Base {
    /**
     * Some KDoc documentation here.
     */
    abstract fun foo()
}

class Derived: Base() {
    /**
     * Here is all the documentation from Base#foo's KDoc inherited.
     *
     * And here goes something more in addition.
     */
    override fun foo() { /* ... */ }
}

1 个答案:

答案 0 :(得分:19)

如果继承的成员没有自己的文档,Dokka总是将文档从基本成员复制到继承成员。无法将基本成员文档与继承成员中提供的其他文本组合在一起。

(Dokka不支持@inheritdoc Javadoc标记,因为这不可避免地导致仅由/** @inheritdoc */组成的评论的扩散,我觉得这些评论非常无用且冗余。)