# source code metrics counter ヘルプ

本ソフトウェアには、以下のツールが含まれています。

ツール名 | 役割 | ツール格納場所
--- | --- | ---
GUIツール | GUIからソースコードメトリクスを測定するツール | <インストールフォルダーパス>¥etc¥ncmeter¥bin¥GUITool.exe
測定コマンド | Windowsのコマンドプロンプトから測定するコマンド | <インストールフォルダーパス>¥etc¥ncmeter¥bin¥ncmeter.exe
帳票作成支援ツール | 測定結果ファイルをわかりやすく表示する、Excel上で動作するツール | <インストールフォルダーパス>¥etc¥FormatTool¥FormatTool.xls

本ヘルプでは測定や、オプションの設定方法、画面操作について説明します。

詳細な測定の設定方法などは、それぞれのマニュアルをご参照ください。

ツール名 | ドキュメント名 | ドキュメント格納場所
--- | --- | ---
GUIツール | ヘルプ(本書) | <インストールフォルダーパス>¥etc¥ncmeter¥doc¥guihelp.html
測定コマンド | マニュアル | <インストールフォルダーパス>¥etc¥ncmeter¥doc¥doc¥index.html
帳票作成支援ツール | 帳票作成支援ツール 操作説明書 | <インストールフォルダーパス>¥etc¥FormatTool¥doc¥index.html

ソフトウェアやアプリケーションなどの名称は商標を参照してください。

## 使い方

▲TOP

本ソフトウェアは、GUIツールと帳票作成支援ツールを使用して、測定と結果の確認を行うことができます。
GUIツールの基本的な使用方法を以下に示します。

- 準備
- 使い方
  - 基本行数の測定
  - 差分行数の測定
  - 構造メトリクスの測定
  - プロパティファイルの編集
- 測定ログの表示

### 準備

▲使い方TOP▲TOP

差分行数の測定、または整形したソースコードでの測定を行う場合、別途ソフトウェアの追加が必要です。
詳細は、「readme.txt」を参照してください。

本ソフトウェアをインストールし、測定するソースコードのファイルを準備します。

ここでは、「C:¥tools¥metrics」フォルダーに本ソフトウェアをインストールしたものとして説明します。
説明に使用する以下のファイルがインストールされていることをご確認下さい。

使用するファイル | インストール先
--- | ---
GUIツール | C:¥tools¥metrics¥bin¥GUITool.exe
帳票作成支援ツール | C:¥tools¥metrics¥etc¥FormatTool¥FormatTool.xls
サンプルファイル(ソースコードファイル) | C:¥tools¥metrics¥etc¥ncmeter¥sample

はじめに、GUIツールから帳票作成支援ツールを使用する設定をします。

1. GUIツールを起動し、【詳細設定...】ボタンを押下します。
2. 詳細設定画面の「ファイルパス」タブが表示されるので、帳票作成支援ツールの設定を行います。
   ここでは、「C:¥tools¥metrics¥etc¥FormatTool¥FormatTool.xls」に保存している帳票作成支援ツールを指定します。
3. 「測定結果表示に「帳票作成支援ツール」を利用する」にチェックを入れます。
4. 【OK】ボタンを押下し、詳細設定画面を終了します。

## 使い方

### 基本行数の測定

▲使い方TOP▲TOP

基本行数の測定方法について説明します。

- ソースコードのファイルの有効行数やコメント行数、空白行数などを測定します。
- ファイル単位に測定します。
- 測定対象は、ファイルまたはフォルダーを複数指定することができます。

以下の説明では、例として「C:¥tools¥metrics¥etc¥ncmeter¥sample¥cnt」のファイルを測定します。

1. 「実行機能」の「基本行数」ラジオボタンを選択します。
2. 「対象ファイルパス」に測定対象のファイルまたはフォルダーを入力します。
   ここでは、「C:¥tools¥metrics¥etc¥ncmeter¥sample¥cnt」を入力します。
   【フォルダ参照…】ボタンでも入力可能です。
3. 【追加】ボタンを押下します。
4. 入力したフォルダーが、測定対象ファイルパスリストに追加されます。
5. 【基本行数 測定開始】ボタンを押下し、測定します。
6. 測定が始まると、ログ表示領域に測定ログが表示されます。
   測定が成功した場合、ログの最後に「Command successed.」と表示されます。
7. 【結果表示】ボタンを押下します。
   測定結果のncmeter.csvファイルを表示します。
8. CSVファイルが関連付けられたExcelで、帳票作成支援ツールが起動し、測定結果ファイルを整形して表示します。
   帳票作成支援ツールの詳細については、帳票作成支援ツールのマニュアルを参照してください。

### 差分行数の測定

▲使い方TOP▲TOP

差分行数の測定方法について説明します。

- 指定したファイル同士の差分行数を測定します。
- オリジナルと変更後の2つのファイルを比較し、無変更行数、追加行数、削除行数、変更行数を測定します。
- 測定対象として、オリジナルと変更後のファイルまたはフォルダーを指定します。
- 次の２種類の測定方法を選択することができます。
  - ファイル単位の測定
    差分行数をファイル単位で測定します。
  - 関数単位の測定
    差分行数を関数単位で測定します。
    C/C++言語のソースコードのファイルのみ対応しています。
  測定方法を切り替えるにはプロパティファイルを編集します。 プロパティファイルの編集については、「プロパティファイルの編集」を参照してください。

以下の説明では、サンプルファイル「C:¥tools¥metrics¥etc¥ncmeter¥sample¥diff」配下の「before」「after」フォルダーのファイルの差分行数を測定します。

1. 「実行機能」の「差分行数」ラジオボタンを選択します。
2. 「オリジナルの対象ファイルパス」に測定対象のファイルまたはフォルダーを入力します。
   ここでは、「C:¥tools¥metrics¥etc¥ncmeter¥sample¥diff¥before」を入力します。
   【フォルダ参照…】ボタンでも入力可能です。
3. 「変更後の対象ファイルパス」に測定対象のファイルまたはフォルダーを入力します。
   ここでは、「C:¥tools¥metrics¥etc¥ncmeter¥sample¥diff¥after」を入力します。
   【フォルダ参照…】ボタンでも入力可能です。
4. 【差分行数 測定開始】ボタンを押下し、測定します。
5. 測定結果の確認手順は「基本行数の測定」の6項以下をご覧下さい。

### 構造メトリクスの測定

▲使い方TOP▲TOP

構造メトリクスの測定方法について説明します。

- プログラムの複雑さに関するメトリクスを測定します。
- 関数単位で測定します。
- 測定対象は、ファイルまたはフォルダーを複数指定することができます。

以下の説明では、サンプルファイル「C:¥tools¥metrics¥etc¥ncmeter¥sample¥cnt」の構造メトリクスを測定します。

1. 「実行機能」の「構造メトリクス」ラジオボタンを選択します。
2. 「対象ファイルパス」に測定対象のファイルまたはフォルダーを入力します。
   ここでは、「C:¥tools¥metrics¥etc¥ncmeter¥sample¥cnt」を入力します。
   【フォルダ参照…】ボタンでも入力可能です。
3. 【追加】ボタンを押下します。
4. 入力したフォルダーが、測定対象ファイルパスリストに追加されます。
5. 【構造メトリクス 測定開始】ボタンを押下し、測定します。
6. 測定結果の確認手順は「基本行数の測定」の6項以下をご覧下さい。

### プロパティファイルの編集

▲使い方TOP▲TOP

本ツールは、測定内容の設定にプロパティファイルを使用します。

- プロパティファイルには、差分行数の測定方式など測定のオプションを指定します。
- プロパティファイルには、ソースコードのプログラミング言語の種類などを定義することもできます。
- 本ソフトウェアインストール直後の状態でのプロパティファイルは<インストールフォルダー>¥etc¥ncmeter¥ncmeter.propertiesです。
- プロパティファイルを複数用意しておき、目的に応じて使い分けることができます

以下に、プロパティファイルの編集方法と、測定内容の設定を説明します。

- プロパティファイルの表示
- 差分行数の関数単位での測定

#### プロパティファイルの表示

▲プロパティファイルの編集TOP▲TOP

プロパティファイルは、GUIツールから参照することができます。

1. 【詳細設定...】ボタンを押下し、詳細設定画面を表示します。
2. 詳細設定画面で「ファイルパス」タブを選択します。
3. 「プロパティファイルパス」の【編集…】ボタンを押下します。
4. プロパティファイル(ncmeter.properties)が「メモ帳(notepad.exe)」で開きます。
   必要に応じて属性の値を変更し保存します。保存後、メモ帳を終了させます。

### 差分行数の関数単位での測定

▲プロパティファイルの編集TOP▲TOP

差分行数を関数単位で測定するための設定について説明します。

- 差分行数の関数単位での測定
- C/C++言語のソースコードのファイルは、関数単位で差分行数を測定することができます。
- 関数単位で差分行数を測定するには、プロパティファイルの設定を変更します。

1. [INIT]項目内の"DIFF_PARSE"属性の値を"FILE"から"FUNC"に変更し保存します。
   保存後、メモ帳を終了します。
2. 【OK】ボタンを押下し、詳細設定画面を終了します。
3. 操作画面に戻り、差分行数の測定と同じように測定対象を指定し、測定します。

### 測定ログの表示

▲使い方TOP▲TOP

GUIツールで測定した測定ログを表示することができます。

1. GUIツールで測定後、【ログ表示】ボタンを押下します。
2. .txtファイルが関連付けられたメモ帳などのツールが起動し、測定ログ(log.txt)を表示します。

詳細な測定方法や、指定可能なオプションは「操作画面説明」、「詳細設定画面説明」の章にて記載します。

▲TOP

## 操作画面説明

▲TOP

GUIツールの画面説明を以下に示します。

- 操作画面説明
  - メイン画面
  - メニュー
  - 実行機能
  - 測定結果フォルダパス
  - 操作機能
- 詳細設定画面説明
  - 「ファイルパス」タブ
  - 「動作設定」タブ

### メイン画面

▲操作画面説明TOP▲TOP

以下はGUIツールを起動した直後の画面です。

実行する測定の種類を、画面内の「実行機能」に表示される以下のラジオボタンによって選択します。

- 基本行数
  ファイルの行数を測定する場合に選択します。
- 差分行数
  ファイル同士の差分行数を測定する場合に選択します。
- 構造メトリクス
  構造メトリクスを測定する場合に選択します。

### メニュー

▲操作画面説明TOP▲TOP

#### 「ファイル」メニュー

終了 (X)
GUIツールを終了します。
キーボードの　[ALT] → [F] → [X] 押下でも選択可能です。
右上の「×」ボタン押下でもGUIツールを終了することができます。

補足
GUIツール終了時、画面にて設定した情報を保持するために、GUIツールの実行ファイルと同一フォルダーにgui.iniファイルを作成します。
次回のGUIツール起動時に、このgui.iniファイルが存在する場合、保存された設定情報を読込んだ状態で画面が表示されます。
設定情報をインストール直後の状態に戻すためには、gui.iniファイルを削除後にGUIツールを起動してください。

#### 「ツール」メニュー

詳細設定 (O)
詳細設定画面を表示します。
キーボードの　[ALT] → [T] → [O] 押下でも選択可能です。

#### 「ヘルプ」メニュー

ヘルプ (H)
ヘルプを表示します。
キーボードの　[ALT] → [H] → [H] 押下でも選択可能です。

バージョン情報 (A)
GUIツールのバージョン情報を表示します。
キーボードの　[ALT] → [H] → [A]
押下でも選択可能です。

### 実行機能

▲操作画面説明TOP▲TOP

##### 対象ファイルパス

基本行数、構造メトリクスを測定する場合に指定します。

測定対象のファイル、またはフォルダーを複数個、指定することができます。
対象ファイルパス入力領域にファイル、またはフォルダーを入力し、【追加】ボタンを押下することにより、測定対象として対象ファイルパスリストに追加されます。

補足
対象ファイルパス入力領域には以下の方法でも入力可能です。

- ファイルパス文字列のコピー＆ペースト
- 【フォルダ参照…】ボタン押下によるフォルダーのパスの選択
- 【ファイル参照…】ボタン押下によるファイルのパスの選択
- ファイルまたはフォルダーのドラッグアンドドロップ
  直接、対象ファイルパスリストへドラッグアンドドロップします。
  以降で説明する、ファイルパスやファイルパスリストも、同様にドラッグアンドドロップによる入力が可能です。

注意
対象ファイルパスリストに追加されたものだけが測定対象となります。
対象ファイルパスの入力後に【追加】ボタンを押下して、対象ファイルパスリストに追加してください。

差分行数を測定する場合に指定します。

##### オリジナルの対象ファイルパス

オリジナルの対象ファイル、またはフォルダーを入力します。

##### 変更後の対象ファイルパス

変更後の対象ファイル、またはフォルダーを入力します。

#### 測定結果フォルダパス

▲操作画面説明TOP▲TOP

測定結果フォルダパスを指定します。

##### 測定結果フォルダパス

測定結果のフォルダーパスを入力します。
測定結果フォルダパス入力領域には以下の方法でも入力可能です。

- ファイルパス文字列のコピー&ペースト
- 【フォルダ参照…】ボタン押下によるフォルダーパスの選択
- ファイルまたはフォルダーのドラッグアンドドロップ
  ファイルをドラッグアンドドロップした場合は、フォルダーパスに編集してご利用ください。

##### 測定結果ファイル名

測定結果ファイル名を入力します。
測定結果ファイルの拡張子は、CSV形式またはXML形式のどちらか一方を指定することができます。
詳細設定ダイアログの動作設定タブにて設定できます。

測定結果をCSV形式、または帳票作成支援ツールで参照したい場合は、出力フォーマットはCSV形式を指定してください。

出力フォーマット | 拡張子
--- | ---
CSV形式 | .csv
XML形式 | .xml

##### サフィックスを追加する

チェックボックスをオンにした場合、測定結果ファイル名の後ろに、以下の表にある識別文字列と実行日時を自動的に付加します。
繰り返し測定を行い、測定結果を上書きしたくない場合に便利です。
出力形式：”測定結果ファイル名”_”識別文字列”_YYYYMMDDhhmmss

測定種類 | 識別文字列
--- | ---
基本行数 | row
差分行数 | diff
構造メトリクス | struct

(例)
abc_row_20150102030405

#### 操作機能

▲操作画面説明TOP▲TOP

ツールの操作に関する機能です。

##### 【測定開始】ボタン

選択された実行機能にて、測定を開始します。
選択された測定種類により、ラベルの表示が切り替わります。
測定実行中は、ラベルの表示が「中断」に切り替わり、【中断】ボタンを押下することにより、測定を中断することができます。

測定種類 | ラベルの表示
--- | ---
基本行数 | 「基本行数 測定開始」
差分行数 | 「差分行数 測定開始」
構造メトリクス | 「構造メトリクス 測定開始」

##### 【詳細設定...】ボタン

「詳細設定」画面を表示します。

##### 【結果表示】ボタン

測定結果ファイルを表示します。
CSVファイル、またはXMLファイルに関連付けられたアプリケーションが起動し、測定結果を表示します。
一般的には、CSVファイルを開いた場合Excelが起動し、XMLファイルを開いた場合はInternet Explorerが起動します。

状態 | 【結果表示】ボタンの押下
--- | ---
測定成功時 | 押下可能
測定失敗時 | 押下不可能

##### 【ログ表示】ボタン

測定ログを表示します。
txtファイルに関連付けられたメモ帳などが起動し、測定ログを表示します。

状態 | 【ログ表示】ボタンの押下
--- | ---
測定実行前 | 押下不可能
測定実行後 | 押下可能

##### ログ表示領域

ログ表示領域に測定ログを表示します。
測定成功時には、末尾に「Command successed.」が表示されます。
また、測定時のログの内容は、GUIツールと同一フォルダー内に「log.txt」のファイル名でも出力されます。
このログファイルは、【測定開始】ボタン押下時に上書きされます。

## 詳細設定画面説明

▲TOP

詳細設定画面の説明を以下に示します。

- 「ファイルパス」タブ
- 「動作設定」タブ

#### 「ファイルパス」タブ

▲詳細設定画面説明TOP▲TOP

ファイルパスに関する設定です。

##### プロパティファイルパス

プロパティファイルのパスを指定します。

インストール直後の状態では、ツールのインストール先フォルダーからの相対パスに存在するプロパティファイルパスが指定されています。

【参照…】ボタンを押下すると、「ファイルの参照」ダイアログが表示され、測定に使用するプロパティファイルを指定することができます。
【編集…】ボタンを押下すると、「メモ帳」が起動し、プロパティファイルの参照や編集が可能です。

差分行数の解析方法を切り替えるには
プロパティファイルの[INIT]項目内の"DIFF_PARSE"属性の値を下記のとおりに指定してください。
(C/C++言語のソースコードファイルのみ対応しています)

差分行数の測定単位 | "DIFF_PARSE"属性の値
--- | ---
ファイル単位 | FILE
関数単位 | FUNC

##### 帳票作成支援ツール

帳票作成支援ツールの利用に関する設定を指定します。

帳票作成支援ツールを使用する場合
『測定結果表示に「帳票作成支援ツール」を利用する』チェックボックスをチェックし、
エディットボックスに「帳票作成支援ツール」のファイルパスを指定してください。
※測定結果の出力フォーマットは、CSV形式を指定してください。
測定後、【結果表示】ボタンを押下すると、帳票作成支援ツールを利用した測定結果を確認できます。
帳票作成支援ツールを使用しない場合
『測定結果表示に「帳票作成支援ツール」を利用する』チェックボックスのチェックを外してください。
※測定結果の出力フォーマットは、CSV形式を指定してください。
測定後、【結果表示】ボタンを押下すると、CSV形式のファイルとして測定結果を確認できます。

帳票作成支援ツールは、メトリクスのしきい値を設定して保存することができます。複数の帳票作成支援ツールを用意して使い分けることができます。

注意
同じファイル名の測定結果を再度帳票作成支援ツールで表示しようとすると警告ダイアログが表示されます。
すでに表示している測定結果を閉じてから、再度表示を行ってください。

#### 「動作設定」タブ

▲詳細設定画面説明TOP▲TOP

動作に関する設定です。

##### ソースコード整形

行数のソースコード整形方法を指定します。

- 整形しない
  測定対象のソースコードを整形せずに測定した結果を出力します。
- 整形する
  測定対象のソースコードを整形して測定します結果を出力します。
- 両方
  測定対象のソースコードを整形せずに測定した結果と、整形して測定した結果の両方を出力します。

##### 表示

表示に関する設定項目を指定します。
チェックした項目がログ表示領域に出力されます。
チェックをしない場合は、コマンドイメージとエラー発生時はエラーメッセージを表示します。

- 処理状況表示
  現在の処理状況を表示します。
- 詳細情報表示
  実行時のデバッグログとエラーが発生した場合のエラーの詳細を表示します。
  デバッグ情報を表示します。

##### 測定結果ファイルのフォーマット

測定結果ファイルのフォーマットを指定します。

- CSV形式
  測定結果をCSV形式で出力します。
  測定結果を帳票作成支援ツールまたはExcelのCSV形式で参照する場合に選択します。
- XML形式
  測定結果をXML形式で出力します。

## 商標

▲TOP

本マニュアルで使用しているアイコンや記号、アプリケーション名などの正式名称、表記について、下記をご覧ください。

- 商標について
- ヘルプでの表記について

### 商標について

▲商標TOP▲TOP

Microsoft、Microsoft Excel、Microsoft Visual Studioは、米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
そのほか、本ヘルプに記載されている会社名、商品名は、各社の商標または登録商標です。

### アプリケーションなどの表記について

▲商標TOP▲TOP

本ヘルプで使用しているアプリケーション名などの正式名称、表記については、下記をご覧ください。

本ヘルプ中の表記 | 正式名称
--- | ---
Microsoft | Microsoft®
Excel | Microsoft® Excel® 2013
Visual Studio | Microsoft® Visual Studio®