我如何继承 KDoc 文档?
How do I inherit KDoc documentation?
在 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() { /* ... */ }
}
如果继承成员没有自己的文档,Dokka 总是将文档从基本成员复制到继承成员。无法将基本成员文档与继承成员中提供的附加文本结合起来。
(Dokka 不支持 @inheritdoc
Javadoc 标签,因为这不可避免地导致仅由 /** @inheritdoc */
组成的注释激增,我发现它非常无用和多余。)
在 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() { /* ... */ }
}
如果继承成员没有自己的文档,Dokka 总是将文档从基本成员复制到继承成员。无法将基本成员文档与继承成员中提供的附加文本结合起来。
(Dokka 不支持 @inheritdoc
Javadoc 标签,因为这不可避免地导致仅由 /** @inheritdoc */
组成的注释激增,我发现它非常无用和多余。)