2016-06-24 10 views
9

メソッド/クラスのコメントをどのように生成しますか?Kotlinメソッド/クラスコメントの生成

/** 

をまた押して入力しますのIntelliJ IDEA Dokkaのように思え2016年1月3日

がKDOCを置き換えたに動作するようには思えないが、なぜIntelliJのではサポートされていません:単純に入力?または私は何かを逃していますか?

明確化:

/** 
* 
*/ 

をしかし、@param、他の世代が追加されていない理由(IntelliJのは、Javaの場合と同様に)私は思ったんだけど:入力/ ** +で入力するとき、これが生成されます。これらのアノテーションは、同様に(https://kotlinlang.org/docs/reference/kotlin-doc.html

+0

'/' + '*' + '*' + 'ENTER'は2016.1.3で私のために'/** \ n * \ n */'を生成します。いくつかのプラグインが問題を引き起こしていますか? – mfulton26

+1

こんにちは、申し訳ありませんが、それが生成されていることを明確にする必要がありますが、ここでは@ params/@ returnが生成されません:https://kotlinlang.org/docs/reference/kotlin-doc.html 編集:質問。 – DenEwout

答えて

8

@paramをKotlinコードを文書化するために使用され、Kotlinのために推奨されるドキュメントのスタイルが[foo]構文を使用して、ドキュメンテーションコメントのテキストからパラメータ名を参照することであるため、他のタグではなく、生成されません明示的な@paramタグを使用してそれらを文書化する。 Kotlin standard library documentationを確認して、このスタイルの使用方法を確認できます。

+0

[Documenting Kotlin Code](https://kotlinlang.org/docs/reference/kotlin-doc.html)ページに、利用可能なすべてのタグの一覧が表示されるのはなぜですか?ここに何かが本当に欠けていますか? – Daksh

+0

タグは使用可能でサポートされていますが、使用するにはあまり意味がありません。 – yole

+0

私はできるだけ詳細に記載された文書化プロセスを記述する文書に私をリンクさせるように頼む必要があります。ありがとう! 前回のコメントに投稿したリンクの様子から、それは公式のKotlin Documentationが使用することが推奨されていたようでした。 – Daksh

関連する問題