Eclipseプラグイン「JavadocDecorator」を作ったよ
いまさらEclipse?
InteliJ IDEAが人気でEclipse使いが減ってきてる印象もありますが、SIerのお堅い仕事の現場では全然現役のEclipse。
そんなお堅い現場だと、クラス名やメソッド名が「業務を識別する接頭辞+連番」だったりして、名前から内容が推測できず、ストレスフルな開発を強いられたりすることもある(実際に見かけたことはあるけど、運良く、自分が直接関わったことはない)。
でもまあ、名前から内容が推測できないという点では、英語で命名されてても英語が苦手な人にとっては結構しんどいんだよね。あと、ローマ字の母音を省略したやつとかも慣れてない人には辛い。
で、内容がわからないからとりあえずソースコード開いてJavadocをチラ見してすぐ閉じる。ってことを無意識にまあまあ頻繁にやってる(はず)。
そこで、そんなストレスを少しでも軽減できればと思いEclipseのプラグイン「JavadocDecorator」を作ってみた。
何ができるプラグインなの?
パッケージエクスプローラなどでツリー表示されてるJava要素(クラスとかメソッドとか)の横っちょに、その要素のJavadocの1行目を表示します。
以上、全機能。
地味。ちょー地味。
でも便利。
英語がわからなくても、
母音省略された暗号的ローマ字でも、
管理都合の名前でも、
ほら!一目瞭然!
って、こんな適当にこさえたサンプルだけだとイメージしづらいところもあると思うし、何よりも適切に命名されたソースコードでもいい感じになるよというアピールのため、ちょっと規模のあるものをgithubから探して表示してみました。
※こちらのリポジトリのソースコードを表示例にお借りしました。
GitHub - jkazama/ddd-java: Spring Boot + Java [ DDD Sample ]
ぜひ使ってみてください。
インストール方法
プラグインのインストール方法はいくつかありますが、代表的な簡単な方法を書きます。
Eclipse Marketplace からのインストール
下のボタンをEclipseのワークベンチにドラッグ&ドロップしてください。
更新サイトからのインストール
[ヘルプ]メニューの[新規ソフトウェアのインストール...]を選択し、次のURLを入力してください。
https://imkrmgn.github.io/JavadocDecorator
※ Eclipse Marketplace からもインストール出来るようにしたくて登録したつもりなんだけど、承認メッセージが届かない。地味すぎると却下とかあるのかな。。。
⇒ 半日ぐらいでメールが届いて登録されました。