しおしお

IntelliJ IDEAのことなんかを書いてます

KDocを生成するIntelliJ IDEAのプラグイン作ったよ

プラグインでできること

下のようにfunctionclassinterface でKDocの開始コメント(/**)を入力してEnterでKDocの雛形が生成されます。 https://raw.githubusercontent.com/siosio/kdoc-generator-intellij-plugin/master/images/gen-kdoc.gif

なんで作ったの?

KT-11079にあるように、公式的にはJavadoc形式の書き方は推奨していないようです。*1
ただ、ちょいちょいJavadoc的なドキュメンテーションを要求されるから、Javadocと同じようにテンプレート生成されるといいんだけどなぁ的なツィートを見かけたので作りました。

インストール方法

公式サイトにアップしてあるので、IntelliJ IDEAのプラグインインストール画面からインストールできます。 IntelliJのバージョンによっては、 kdoc-generator ではなく kodkod という名前で登録されています。
公開は一年前にしていたけど、雑につけていたプラグイン名の変更と、classinterface にも対応するように最近がんばりました。

*1:ちょいちょいYouTrackに同じようなチケットが上がるのですが、全て同じ理由で対応しませんで終わっています。