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 */
私が非常に役に立たない冗長なコメントのみで構成されるコメントが急増するためです。)
この記事はインターネットから収集されたものであり、転載の際にはソースを示してください。
侵害の場合は、連絡してください[email protected]
コメントを追加