言語/Language: en | ja

AccessorJavadoc

概要

Javaのgetterやsetterに対し、対応するクラス変数のJavadocをもとにしたJavadocを生成するEclipseプラグイン。

動作環境

※他のEclipseのバージョンは未検証です。

インストール手順

ver.0.1.0用アップデートサイト

Eclipseのメインメニューの「Help→Install New Software…」を選択するとウィザードが開きます。
開いたウィザードの「Work with:」に上記のサイトを指定すると「AccessorJavadoc」という名前のフィーチャーが表示されます。
チェックをオンにしてNextボタンをクリックし、あとはウィザードの指示に従ってください。

インストールウィザード

使い方

EclipseのJavaエディタでJavaのソースコードを開き、対象のクラスにカーソルを合わせます。(内部クラスも可。)
Eclipseのメインメニュー、またはエディタのコンテキストメニューの「Accessor Javadoc→Generate Getter/Setter Javadocs from Field Javadocs…」を選択するとダイアログが開きます。ショートカットキーは Ctrl+Shift+D です。

ダイアログ

ダイアログにおいて、Javadocを生成したいgetterおよびsetterを選択してOKボタンをクリックすると、選択したgetterおよびsetterにJavadocが付加されます。すでにJavadocが存在する場合は置換されます。

getterおよびsetterの既存のJavadocにタグ@accessorjavadoc.excludedが存在する場合、ダイアログを表示した時点においてそのgetterおよびsetterは非選択状態になります。手動でJavadocを編集した場合に便利です。

設定

Eclipseのメインメニューの「Window→Preferences」を選択してPreferenceダイアログを開きます。
左側からAccessorJavadocを選択すると設定項目が表示されます。

設定項目

Field name regexには、クラス変数の名称にマッチする正規表現を指定します。
()によりグループを指定することで接頭辞や接尾辞を除去した変数名を抽出することができます。接頭辞や接尾辞を除去した部分が正規表現のグループ#1に相当するようにしてください。
なおクラス変数の名称が正規表現にマッチしなくても問題ありませんが、その場合は接頭辞や接尾辞の除去は行われません。
例: (?:[ms]?_)(.+)を指定した場合、変数名は次の通り変換されます。m_foo→foo、s_bar→bar、_baz→baz、qux→そのまま

Getter summary templateSetter summary templateにはそれぞれ、getterおよびsetterのメソッドのJavadocの概要として使われる文字列のテンプレートを指定します。
@param NAME or @return templateには、getterの引数またはsetterの戻り値の説明のテンプレートを指定します。
これらの設定では以下の変数を埋め込むことができます。書式は${変数名}です。

Period charactersには、文末の句点となりうる文字を指定します。複数指定することも可能です。

更新履歴

2017年4月2日
バージョン0.1.0

ライセンス

BSDライセンスを採用しています。


Copyright © 2009-2017 recyclebin5385 All rights reserved.
Generated by webgen