Java用語集チェックツール JGlossary

JGlossary リファレンス

glossary 属性

用語集のテキストファイルを指定します。指定しない場合は、空の用語集に対してマッチングを行いますので Java クラスから単語を抽出するだけの動作となります。用語集を後付けで作成する場合などには、有効な使い方になります。用語集テキストファイルの作成方法は、「使用方法」を参照して下さい。

classes 属性

チェック対象となるクラスファイルが格納されているディレクトリを指定します。一度に１つのみの指定となります。

packages 属性

チェック対象となるパッケージを指定します。カンマ区切りで複数指定可能です。指定されたパッケージ単位でチェック結果を出力します。

また複数指定の場合、「jp.javable.tool.jglossary.*」「jp.javable.tool.*」とパッケージが重なるような指定がされると、後のパッケージでチェック結果が重複して出力されます。同一レベルでの指定を行うようにして下さい。

assortmentError 属性

組合せエラーチェック機能の on/off を切り替えます。組合せエラーとは、用語集で「assortmenterror」という用語が１語で登録されている場合、「assortmentError」というように２語になるような用語の使い方をエラーとし、「assortmenterror」と１語で使用するように促すワーニングメッセージを出力するものです。用語の適用ルールとして「長いものから順に適用する」というようなルールがある場合に有効なチェックオプションです。

postfix 属性

用語として暗黙的に許可される接尾辞がある場合に、ここで指定します。指定はカンマ区切りで複数可能です。

例えば、フィールド名に「modifieddate」という名前がある場合、用語集に「modified」だけしか登録していなくても、postfix 属性に "date" があれば用語として認められます。用語集管理の簡易化の為に、プロジェクト全体で暗黙的に使用する接尾辞などがある場合に有効なオプションです。

availableLength 属性

用語集ファイルの中で、「○桁以上の用語のみチェックとする」というようなルールを適用したい場合に使用します。デフォルトは "1" ですので、1桁以上の全ての用語がチェック対象となりますが、例えばこれを "2" にすると、1桁の用語（"J"など）はチェック対象外として用語には含められません。

splitRule 属性

クラスファイル解析時に、パッケージ名・クラス名・フィールド名・メソッド名を単語に分解する際に適用するルールです。バージョン 0.1.0 では "ignoreNumbers", "includeNumbers", "partOfWord" の３種類のルールがあります。

field 属性

チェック対象となるフィールドのアクセス修飾子を指定します。ただし "protected" と指定すれば protected フィールドのみがチェック対象となるわけではなく、"protected 以上" のアクセス修飾子を持つものが対象となります。詳しくは下記を参照して下さい。

method 属性

チェック対象となるメソッドのアクセス修飾子を指定します。ただし "protected" と指定すれば protected メソッドのみがチェック対象となるわけではなく、"protected 以上" のアクセス修飾子を持つものが対象となります。詳しくは下記を参照して下さい。