プラグインでできること
下のようにfunction
と class
や interface
でKDocの開始コメント(/**
)を入力してEnter
でKDocの雛形が生成されます。
なんで作ったの?
KT-11079にあるように、公式的にはJavadoc形式の書き方は推奨していないようです。*1
ただ、ちょいちょいJavadoc的なドキュメンテーションを要求されるから、Javadocと同じようにテンプレート生成されるといいんだけどなぁ的なツィートを見かけたので作りました。
インストール方法
公式サイトにアップしてあるので、IntelliJ IDEAのプラグインインストール画面からインストールできます。
IntelliJのバージョンによっては、 kdoc-generator
ではなく kodkod
という名前で登録されています。
公開は一年前にしていたけど、雑につけていたプラグイン名の変更と、class
や interface
にも対応するように最近がんばりました。
*1:ちょいちょいYouTrackに同じようなチケットが上がるのですが、全て同じ理由で対応しませんで終わっています。