2017-04-23 6 views
2

私は、ある種のクリックリスナを登録する上位関数を持っているとしましょう。私は、その目的などのように渡されますlistenerパラメータを文書化することができますKotlinの関数パラメータのパラメータの文書化

/** 
* Adds a [listener] that's called when the item is clicked. 
* 
* @param listener The listener to add 
*/ 
fun addClickListener(listener: (count: Int) -> Unit) { 
    ... 
} 

私の質問は、あるlistenerのパラメータを文書化する方法はありますか?この例ではcountとなります。実際の使用例では、リスナーに複数のパラメータがあります。

私が気づいたのは、この機能を使用しているドキュメントビューで[listener]のテキストがクリック可能ですが、それについての空のダイアログが表示されていることです。何らかの形でパラメータを記述する方法はありますか?

enter image description here The listener documentation that comes up

は今のところ、私はaddClickListener方法で@paramブロックとリスナーのパラメータを記述し終わってきたが、これはIDEでの警告になり、そしてそこだ場合、私は思ったんだけどそれを行うより適切な方法。

答えて

5

Kotlin 1.1では、関数パラメータとして使用される関数型のパラメータまたは戻り値を文書化するための構文はありません。これをカバーするopen YouTrack issueがあります。

関連する問題