測定対象となるファイルの種別を特定するための設定や、コメント行数を判断するためのコメント指示文字列を指定することもできます。
プロパティファイルの書式は以下のとおりです。
[項目]
属性=値
各設定情報について、改行区切りで指定してください。
項目を複数指定した場合、最初に指定されたものが有効となります。
属性については大文字、小文字は区別されません。
プロパティファイルの項目は以下のとおりです。
値 | 対象となるソースコードのファイル |
---|---|
* | すべてのソースコードのファイルが対象となります。 |
XXX* | XXX(任意の文字列)と後方一致するソースコードのファイルが対象となります。 |
*XXX | XXX(任意の文字列)と前方一致するソースコードのファイルが対象となります。 |
*XXX* | XXX(任意の文字列)に部分一致するソースコードのファイルが対象となります。 |
XXX | XXX(任意の文字列)に完全一致するソースコードのファイルが対象となります。 |
※注: | 検索順序について |
ファイルの検索順序については、先に指定された条件に一致するものが有効となります。 |
以下に、[INIT]、[LANG]、[ FIRSTLINE_STR]、[COMMENT]それぞれの項目で設定される属性を記載します。
[INIT]
インストール直後の状態では、プロパティファイルの記述にしたがって動作します。
「記述がない場合の動作」と同じでない項目もあります。
属性 | 詳細 | 記述がない場合の動作※1 |
DOC |
仕様コメント行数カウント有無の指定 javadoc行、doxygen行、XMLドキュメントコメントなどを、コメントとは別に仕様コメント行数としてカウントするかどうかを指定します。
| TRUE |
SKIP |
SKIP/MSKIPの測定方式の指定
| NEW |
DIFF_PARSE |
差分行数の測定方式の指定 "-diff"オプションを指定した場合の測定方式を指定します。
| FILE |
DIFF_BLANK |
差分行数の空白の変更の測定有無の指定 差分行数を測定する際に、空白行や空白文字の変更を測定するかどうかを指定します。
|
FALSE |
DIFF_COUNT_MODE |
差分行数の測定内容の出力方法の指定 差分行数での測定を、diffツールの出力内容に基づき、追加/変更/削除に分けて出力します。 |
STD |
STRUCT_FUNC_OPTION |
測定結果ファイルに出力される関数名へのパラメータの型付加有無の指定 構造メトリクスの測定時に、測定結果ファイルに出力される関数名に渡されるパラメータの型を付加して出力するかを指定します。
| PARAM |
NESTS_COUNT |
構造メトリクスでのNESTSカウント方式の指定
|
INNERBLOCK |
OUT_FORMAT |
測定結果ファイルのフォーマットの指定
|
CSV | NKF |
文字コード変換有無の指定 入力ファイルの文字コードを、UTF-8(BOMなし)に変換後に測定を行うかを指定します。
|
TRUE |
NKFEXE |
文字コード変換パスの指定 文字コード変換に使用するツールのパス(拡張子も含む)を指定します。 ツールのパスに空白が含まれる場合、ツールのパスを""で囲む必要があります。 ツールに指定するオプションが存在する場合は、パス名の後にスペース区切りでオプションを指定してください。 英語OS(英語ロケール)の環境では、日本語を含むパスは指定できません。 インストール直後の状態のプロパティファイルにはこの属性は設定されていません。 |
同梱されているnkf.dllを利用する |
BEAUTIFIER |
ソースコード整形有無の指定 測定を行う前に、入力ファイルのソースコードを整形し、測定するかを指定します。
|
FALSE |
BEAUTIFIEREXE |
ソースコード整形ツールのパスの指定 ソースコード整形に使用するツールのパス(拡張子も含む)を指定します。 ツールのパスに空白が存在する場合、ツールのパスを""で囲む必要があります。 ツールに指定するオプションが存在する場合は、パス名の後にスペース区切りでオプションを指定してください。 英語OS(英語ロケール)の環境では、日本語を含むパスは指定できません。 インストール直後の状態のプロパティファイルにはこの属性は設定されていません。 |
本ソフトウェアが指定する場所にuncrustify.exeがない場合エラー発生 |
JAVAEXE |
Javaの構造メトリクスの測定時に利用するJava実行環境のパスの指定 複数のJava実行環境がインストールされている場合などに、本ソフトウェアで使用するJava実行環境をパス名(Javaコマンドファイル名を含む)で指定します。 ツールのパスに空白が含まれる場合、パスを""で囲む必要があります。 コマンドが見つからない場合は、エラーメッセージを表示し、解析は行われません。 英語OS(英語ロケール)の環境では、日本語を含むパスは指定できません。 特定のJREを使用して測定する場合は、パス名を指定してください。
|
測定を実行するOSのJava実行環境の設定に従う |
COMMENT_CASE_SENSITIVE |
コメント指示文字列の大文字・小文字の区別有無の指定 プロパティファイルの[COMMENT]項目に指定された文字列をソースコード中で検索する処理において、大文字・小文字の違いを区別するかどうかを設定します。
|
TRUE |
EXCEPT_BINARY |
バイナリファイル除外有無の指定 「そのほかの言語」にマッチするファイルが、バイナリファイルか否かをチェックして測定対象から除外するかを設定します。
ファイルの先頭から最大1024バイトの内容を読み込む。 (1024バイト未満のファイルはすべて読み込む)
|
FALSE |
STMT |
ステートメント数(STMT)測定有無の指定 基本行数の測定時間を短くする目的で、 ステートメント数の測定が不要の場合に、本オプションを指定します。
|
TRUE |
CHARSET_OUT_CSV |
CSV形式の測定結果ファイルの文字コードの指定 CSV形式の測定結果ファイルで使用する文字コードを指定します。 文字コードには、次の指定が可能です。
|
SYSTEM |
CHARSET_OUT_LOG |
測定ログファイルの文字コードの指定 測定ログファイルで使用する文字コードを指定します。 文字コードには、次の指定が可能です。
|
SYSTEM |
※1 | 記述がない場合の動作とは、以下の場合を指します。 |
※2 | 空白文字や空白行を変更なしとする条件について |
言語種別がTXT以外の言語種別のファイルに関して、以下の場合は変更なしとして扱います。 |
※3 | 差分行数の測定について |
出力する差分行数(追加/変更/削除/無変更)の測定は、本ツールで利用するdiffツールの比較測定結果に従いカウントしています。 |
[LANG]
インストール直後の状態では、プロパティファイルの記述にしたがって動作します。
「記述がない場合の動作」と同じでない項目もあります。
属性 | 詳細 | 記述がない場合の動作※1 |
CPP |
C++言語ファイル C++言語ファイルのファイル名条件が指定できます。 |
*.cpp |
CPPH |
C++言語(ヘッダー)ファイル C++言語(ヘッダー)ファイルのファイル名条件が指定できます。 |
*.h |
C |
C言語ファイル C言語ファイルのファイル名条件が指定できます。 |
*.c |
CH |
C言語(ヘッダー)ファイル C言語(ヘッダー)ファイルのファイル名条件が指定できます。 |
*.h (CPPHで表示) |
JAVA |
Java言語ファイル Java言語ファイルのファイル名条件が指定できます。 |
*.java |
CS |
C#言語ファイル C#言語ファイルのファイル名条件が指定できます。 |
*.cs |
VB |
Visual Basic言語ファイル Visual Basic言語ファイルのファイル名条件が指定できます。 |
*.vb |
JS |
JavaScript言語ファイル JavaScript言語ファイルのファイル名条件,先頭行条件が指定できます。 |
*.js |
TXT |
テキストファイル 改行の行数がカウントされます。テキストファイルのファイル名条件が指定できます。 |
- (測定されません) |
(任意の文字列) |
そのほかの言語のファイル (任意の文字列) には、半角英字で始まる6文字以内の半角英数字が指定できます。 '(任意の文字列)=' に続けて、ファイル名条件と先頭行条件が指定できます。 また、本属性に指定されたファイルについては、下記の[COMMENT]項目にて、言語ごとのコメント指示文字列が指定可能です。 コメント指示文字列を指定することでコメント行数のカウントを行います。
|
- (測定されません) |
※1 | 記述がない場合の動作とは、以下の場合を指します。 |
属性(先頭行条件) | 詳細 |
$1〜$99 |
先頭行条件文字列 [LANG]項目のファイル名条件だけでは言語種別が定義できない場合、ファイルの1行目に含まれる文字列を[FIRSTLINE_STR]項目で指定できます。 (主としてmakefileやスクリプトのように拡張子がないファイルを識別する場合などに利用します)
|
上記 [LANG]項目内で、「そのほかの言語のファイル」として指定された属性に対応する
コメント指示文字列を指定します。
各属性につき、コメント指示文字列を単一行コメント、複数行コメントの合計で32個まで指定できます。
33個以上指定された場合は、33個目からは無視されます。