本ソフトウェアには、以下のツールが含まれています。
ツール名 | 役割 | ツール格納場所 |
---|---|---|
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 |
ソフトウェアやアプリケーションなどの名称は商標を参照してください。
本ソフトウェアは、GUIツールと帳票作成支援ツールを使用して、測定と結果の確認を行うことができます。
GUIツールの基本的な使用方法を以下に示します。
差分行数の測定、または整形したソースコードでの測定を行う場合、別途ソフトウェアの追加が必要です。
詳細は、「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ツールから帳票作成支援ツールを使用する設定をします。
基本行数の測定方法について説明します。
以下の説明では、例として「C:¥tools¥metrics¥etc¥ncmeter¥sample¥cnt」のファイルを測定します。
差分行数の測定方法について説明します。
以下の説明では、サンプルファイル「C:¥tools¥metrics¥etc¥ncmeter¥sample¥diff」配下の「before」「after」フォルダーのファイルの差分行数を測定します。
構造メトリクスの測定方法について説明します。
以下の説明では、サンプルファイル「C:¥tools¥metrics¥etc¥ncmeter¥sample¥cnt」の構造メトリクスを測定します。
本ツールは、測定内容の設定にプロパティファイルを使用します。
以下に、プロパティファイルの編集方法と、測定内容の設定を説明します。
プロパティファイルは、GUIツールから参照することができます。
差分行数を関数単位で測定するための設定について説明します。
GUIツールで測定した測定ログを表示することができます。
詳細な測定方法や、指定可能なオプションは「操作画面説明」、「詳細設定画面説明」の章にて記載します。
GUIツールの画面説明を以下に示します。
以下はGUIツールを起動した直後の画面です。
実行する測定の種類を、画面内の「実行機能」に表示される以下のラジオボタンによって選択します。
終了 (X)
GUIツールを終了します。
キーボードの [ALT] → [F] → [X]
押下でも選択可能です。
右上の「×」ボタン押下でもGUIツールを終了することができます。
詳細設定 (O)
詳細設定画面を表示します。
キーボードの [ALT] → [T] → [O] 押下でも選択可能です。
ヘルプ (H)
ヘルプを表示します。
キーボードの [ALT] → [H] → [H]
押下でも選択可能です。
バージョン情報 (A)
GUIツールのバージョン情報を表示します。
キーボードの [ALT] → [H] → [A]
押下でも選択可能です。
基本行数、構造メトリクスを測定する場合に指定します。
測定対象のファイル、またはフォルダーを複数個、指定することができます。
対象ファイルパス入力領域にファイル、またはフォルダーを入力し、【追加】ボタンを押下することにより、測定対象として対象ファイルパスリストに追加されます。
差分行数を測定する場合に指定します。
オリジナルの対象ファイル、またはフォルダーを入力します。
変更後の対象ファイル、またはフォルダーを入力します。
測定結果フォルダパスを指定します。
測定結果のフォルダーパスを入力します。
測定結果フォルダパス入力領域には以下の方法でも入力可能です。
測定結果ファイル名を入力します。
測定結果ファイルの拡張子は、CSV形式またはXML形式のどちらか一方を指定することができます。
詳細設定ダイアログの動作設定タブにて設定できます。
測定結果をCSV形式、または帳票作成支援ツールで参照したい場合は、出力フォーマットはCSV形式を指定してください。
出力フォーマット | 拡張子 |
---|---|
CSV形式 | .csv |
XML形式 | .xml |
チェックボックスをオンにした場合、測定結果ファイル名の後ろに、以下の表にある識別文字列と実行日時を自動的に付加します。
繰り返し測定を行い、測定結果を上書きしたくない場合に便利です。
出力形式: ”測定結果ファイル名”_”識別文字列”_YYYYMMDDhhmmss
測定種類 | 識別文字列 |
---|---|
基本行数 | row |
差分行数 | diff |
構造メトリクス | struct |
(例)
abc_row_20150102030405
ツールの操作に関する機能です。
選択された実行機能にて、測定を開始します。
選択された測定種類により、ラベルの表示が切り替わります。
測定実行中は、ラベルの表示が「中断」に切り替わり、【中断】ボタンを押下することにより、測定を中断することができます。
測定種類 | ラベルの表示 |
---|---|
基本行数 | 「基本行数 測定開始」 |
差分行数 | 「差分行数 測定開始」 |
構造メトリクス | 「構造メトリクス 測定開始」 |
「詳細設定」画面を表示します。
測定結果ファイルを表示します。
CSVファイル、またはXMLファイルに関連付けられたアプリケーションが起動し、測定結果を表示します。
一般的には、CSVファイルを開いた場合Excelが起動し、XMLファイルを開いた場合はInternet Explorerが起動します。
状態 | 【結果表示】ボタンの押下 |
---|---|
測定成功時 | 押下可能 |
測定失敗時 | 押下不可能 |
測定ログを表示します。
txtファイルに関連付けられたメモ帳などが起動し、測定ログを表示します。
状態 | 【ログ表示】ボタンの押下 |
---|---|
測定実行前 | 押下不可能 |
測定実行後 | 押下可能 |
ログ表示領域に測定ログを表示します。
測定成功時には、末尾に「Command successed.」が表示されます。
また、測定時のログの内容は、GUIツールと同一フォルダー内に「log.txt」のファイル名でも出力されます。
このログファイルは、【測定開始】ボタン押下時に上書きされます。
詳細設定画面の説明を以下に示します。
ファイルパスに関する設定です。
プロパティファイルのパスを指定します。
インストール直後の状態では、ツールのインストール先フォルダーからの相対パスに存在するプロパティファイルパスが指定されています。
【参照…】ボタンを押下すると、「ファイルの参照」ダイアログが表示され、測定に使用するプロパティファイルを指定することができます。
【編集…】ボタンを押下すると、「メモ帳」が起動し、プロパティファイルの参照や編集が可能です。
差分行数の解析方法を切り替えるには
プロパティファイルの[INIT]項目内の"DIFF_PARSE"属性の値を下記のとおりに指定してください。
(C/C++言語のソースコードファイルのみ対応しています)
差分行数の測定単位 | "DIFF_PARSE"属性の値 |
---|---|
ファイル単位 | FILE |
関数単位 | FUNC |
帳票作成支援ツールの利用に関する設定を指定します。
帳票作成支援ツールを使用する場合
『測定結果表示に「帳票作成支援ツール」を利用する』チェックボックスをチェックし、
エディットボックスに「帳票作成支援ツール」のファイルパスを指定してください。
※測定結果の出力フォーマットは、CSV形式を指定してください。
測定後、【結果表示】ボタンを押下すると、帳票作成支援ツールを利用した測定結果を確認できます。
帳票作成支援ツールを使用しない場合
『測定結果表示に「帳票作成支援ツール」を利用する』チェックボックスのチェックを外してください。
※測定結果の出力フォーマットは、CSV形式を指定してください。
測定後、【結果表示】ボタンを押下すると、CSV形式のファイルとして測定結果を確認できます。
帳票作成支援ツールは、メトリクスのしきい値を設定して保存することができます。複数の帳票作成支援ツールを用意して使い分けることができます。
動作に関する設定です。
行数のソースコード整形方法を指定します。
表示に関する設定項目を指定します。
チェックした項目がログ表示領域に出力されます。
チェックをしない場合は、コマンドイメージとエラー発生時はエラーメッセージを表示します。
測定結果ファイルのフォーマットを指定します。
本マニュアルで使用しているアイコンや記号、アプリケーション名などの正式名称、表記について、下記をご覧ください。
Microsoft、Microsoft Excel、Microsoft Visual Studioは、米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
そのほか、本ヘルプに記載されている会社名、商品名は、各社の商標または登録商標です。
本ヘルプで使用しているアプリケーション名などの正式名称、表記については、下記をご覧ください。
本ヘルプ中の表記 | 正式名称 |
---|---|
Microsoft | Microsoft® |
Excel | Microsoft® Excel® 2013 |
Visual Studio | Microsoft® Visual Studio® |