ゴミ箱.net

汚物は消毒

getter、setterのJavadocを生成するEclipseプラグイン

Eclipseを使ってJavaのプログラムを開発していると、クラスにprivateなクラス変数を作ってそれにgetter、setterを作ることが多い。
だがそうするとgetterとsetterにほとんど同じようなJavadocを書かねばならなくなって二度手間である。

その手間を省くために、これまでLimy Eclipse Pluginを使ってきた。getter、setterに対応するクラス変数にJavadocを書いておくと、それをコピーしてgetter、setterのJavadocを追加してくれるのだ。
だが、Limy Eclipseが提供しているいくつもの機能のうちで自分が必要なのは、このJavadoc生成機能だけなのだ。それだけのためにたくさんの機能をインストールすることには抵抗がある。
また、Limy Eclipseではクラス変数のJavadocに複数の文を記述することができない。Javadocで概要として認識される最初の文のみがコピーされてgetterやsetterのJavadocになるが、るが、句点までコピーしてそれに「を取得する。」とか「を設定する。」をつけるような形になるので文章としておかしくなってしまう。そのため、クラス変数のJavadocには変数の説明を句点をつけずに1つの文で記述するしかなくなってしまう。そうするとgetterやsetterのJavadocに記述できる内容もおのずと限られてしまう。
何より致命的なのは、このプラグインはクラスの中に入れ子で定義された内部クラスに対応していないのだ。内部クラスに対しては手でJavadocを書くか、別のソースファイルを作ってそこでLimy Eclipseの機能でJavadocを生成して元のソースファイルにペーストするみたいな面倒な手順を踏まねばならなかった。

そこで、getter、setterのJavadocを生成する機能に特化したEclipseのプラグインを自分で作ってみた。
名づけてAccessorJavadoc。以下のURLからインストールすることができる。
AccessorJavadoc - 自作ソフトの墓場
Limy Eclipseとの差別化として、クラス変数のJavadocの全体をgetter、setterのJavadocにコピーしてくれる。その際、最初の文のみをうまく書き換えてくれる。
また、内部クラスにも対応している。

それにしても、同じような機能を持ったプラグインを探し回ったことがあるが、Limy Eclipse以外に見つけることができなかった。
そういうプラグインの需要はありそうなのに、探すと意外とないというのは不思議だ。
スポンサーサイト

PageTop

コメント


管理者にだけ表示を許可する