Share |

JGlossary リファレンス

属性一覧

Ant の入手・使用方法については、Apache Ant プロジェクトのサイト を参照して下さい。

JGlossary Ant タスクの指定可能属性のリファレンスを下に示します。「指定できる値」で「"on" または "off"」となっているものは、値として「yes/no」「true/false」も指定可能です。詳細な説明は、一覧表の下の各属性についての説明を参照して下さい。

属性 説明 指定できる値 初期値 必須
glossary 用語集テキストファイル名 ファイル名
classes チェック対象となるクラスファイルの格納ディレクトリ パス文字列(指定は1つのみ可能)
packages チェック対象となるパッケージ名 カンマ区切りで複数可能
verbose 詳細情報の出力 "on" または "off" "off"
assortmentError 組合せエラーの実行可否 "on" または "off" "off"
postfix 許可する接尾辞の指定 カンマ区切りで複数の文字列を指定可能
availableLength 用語集ファイルでチェック対象となる用語の最小桁数 数値 "1"
splitRule 単語分割ルール "ignoreNumbers",
"includeNumbers",
"partOfWord"
"ignoreNumbers"
outFile 出力結果 HTML ファイル名 任意のファイル名 "jglossary.html"
field チェック対象となるフィールドのアクセス修飾子 "public",
"protected",
"package",
"private"
"private"
method チェック対象となるメソッドのアクセス修飾子 "public",
"protected",
"package",
"private"
"public"

glossary 属性

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

classes 属性

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

packages 属性

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

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

assortmentError 属性

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

postfix 属性

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

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

availableLength 属性

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

splitRule 属性

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

"ignoreNumbers" ルール

"ignoreNumbers" ルールでは下記のような単語分割ルールを適用します。

  1. 英大文字を単語区切りとする。
    例)splitRule → split, Rule
  2. "_" を単語区切りとする。
    例)SPLIT_RULE → SPLIT, RULE
  3. "$" を単語区切りとする。
    例)SPLIT$RULE → SPLIT, RULE
  4. 連続する英大文字を1つの単語とする。
    例)SPLITRule → SPLIT, Rule
  5. 数字を単語区切りとし、数字は単語に加えない。
    例)Split2Rule → Split, Rule
    例)SplitRule2 → Split, Rule

"includeNumbers" ルール

"ignoreNumbers" ルールと 1 ~ 4 のルールは共通です。 5 番目の数字の扱いに関するところのみ、下記のようになります。

  • 数字を単語区切りとし、直前の単語の末尾に加える。
    例)Split2Rule → Split2, Rule
    例)SplitRule2 → Split, Rule2

"partOfWord" ルール

"ignoreNumbers" ルールと 1 ~ 4 のルールは共通です。 5 番目の数字の扱いに関するところのみ、下記のようになります。

  • 数字を単語区切りとしない。
    例)Split2Rule → Split2, Rule
    例)native2ascii → native2ascii

field 属性

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

対象範囲
"public" public フィールドが対象
"protected" public, protected フィールドが対象
"package" public, protected, パッケージプライベート(デフォルト)フィールドが対象
"private" 全てのフィールドが対象

method 属性

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

対象範囲
"public" public メソッドが対象
"protected" public, protected メソッドが対象
"package" public, protected, パッケージプライベート(デフォルト)メソッドが対象
"private" 全てのメソッドが対象