2016-03-03 24 views
9

JavaのJavadocでは、{@inheritDoc} tagを使用してサブクラスでメソッドのドキュメントを継承する方法があります。KDocのドキュメントをどのように継承しますか?

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() { /* ... */ } 
} 
+0

ん '{@inheritDoc}'動作しませんか?それを試しましたか? – CaseyB

+0

@CaseyB、はい、しましたが、IntelliJもdokkaもそれを理解していないので、テキストとして表示します。 – hotkey

+2

私の発見を文書化しているものは見つかりませんでしたが、Kotlin Docは、オーバーライドでドキュメントが指定されていない場合、関数をオーバーライドするときにドキュメンテーションを継承しています。今私が思っているのは、基本ドキュメンテーションを "拡張"/"インクルード"する方法です... – mfulton26

答えて

10

Dokka常にコピードキュメント:

基本的に、私は何をしたいのは、次のようです。継承されたメンバで提供される追加のテキストと基本メンバのドキュメントを組み合わせる方法はありません。

(これは必然的にのみ/** @inheritdoc */私はスーパー無用と冗長見つけたから成るコメントの増殖につながるためDokkaが@inheritdocのJavadocタグをサポートしていません。)

+4

しかし、何も書かれていない継承された関数で 'Ctrl + Q 'を押すと、何も表示されませんが、基本関数はそれを指定していますし、' Ctrl + B' + Q 'を押すと、ドキュメンテーションが表示されます。たぶんこれはide-pluginのバグです。 – dimsuz

+1

@yole Javaクラス/インタフェースからオーバーライドされたメソッドのクイックドキュメントショートカットを表示すると、基本クラス/インタフェースにいくつかのドキュメントがある間はドキュメントが表示されません。これは本当に不便です。そこに未解決の問題はありますか? –

関連する問題