以下では、本スクリプトを実行する際に設定する値、利用するコマンド、及び実行時の注意点について記載しています。
なお、以下の記載は、スクリプトの内容と照らし合わせながらご確認ください。
また、初めて本スクリプトを実行する際は、環境設定が比較的容易であるis_read_csvをTrueとした設定で実行されることをお勧めいたします。

本スクリプトを実行する際に設定する値、利用するコマンド

[1.1]初期設定(共通設定)

解析対象の設定変数（is_git, is_svn, is_read_csv）の説明と意味

is_git, is_svn, is_read_csvのいずれか1つをTrueとし、それ以外をFalseとしてください。

設定変数 説明
is_git Trueとした場合、Gitリポジトリからソースコードを取得することでメトリクスを取得します。
is_svn Trueとした場合、Svnリポジトリからソースコードを取得することでメトリクスを取得します。
is_read_csv Trueとした場合、既存のcsvファイルからメトリクスを取得します。

設定変数の説明

設定変数 説明
is_to_html Trueとした場合、グラフをhtmlで保存できます。
is_to_csv Trueとした場合、集計データをcsvで保存できます。
isRemovePrefix 後述prefix変数の文字列を削除するかどうかを指定する真偽値です。
prefix メトリクス表内におけるファイルパス文字列の削除対象文字列を指定しています。
ファイルパスが長くなると描画時などに読みづらさの原因となるためその対策です。
is_gitもしくは is_svnをTrueとした場合は、isRemovePrefixをTrueとした上で、
[2.1]で設定するdirPathRepoのlastnameを除外した文字列を設定することをお勧めいたします。
is_read_csvをTrueとした場合は、csvファイル内のファイルパス文字列に合わせて設定してください。
os.environ["PATH"] 環境変数を設定しています。undコマンドのパスを追加設定してください。
※ なお、is_gitがTrueの場合はgitコマンド、is_svnがTrueの場合はsvnコマンドを実行可能であることを前提としています。
実行可能でない場合にはエラーが発生します。

[1.2]言語設定(共通設定)

設定変数 説明
language "C", "C++", "JAVA", "C#"のいずれかを設定してください。
”C”または"C++"を設定した場合には、Fuzzyモードが適用されます。
languageは利用者側で追加可能ですが、
Understandにおいて解析可能な言語限定となります。

[2.1]Git/Svn利用時の設定(Git利用時またはSvn利用時のみ)

処理記載箇所 説明
initDirectory()関数内dirPathRepoResult=dirPathRepo+"/Result" 解析結果の格納先ディレクトリを指定しています。
getMetrics()関数内 metrics変数 本スクリプト内でデータとして読み込むメトリクスを指定しています。基本的に変更不要です。

[2.2]Git/Svnチェックアウト時の設定(Git利用時またはSvn利用時のみ)

[if is_svn条件文内](Svn利用時のみ)

変数 説明
checkoutURLRoot SvnリポジトリURLのRootを指定します。
svnProjectPathString SvnリポジトリURLのうち、Root部分を除くチェックアウト対象ディレクトリパス文字列を指定します。
Root直下を全てチェックアウト及び解析対象とすると、
非常に時間がかかります。
このため、最初はチェックアウト対象を絞ることをお勧めいたします。
なお、svnProjectPathStringの"/"でセパレートされた最後の文字列を、プロジェクト名と認識します。
dirPathRepo 解析対象リポジトリをチェックアウトするための親ディレクトリを指定します。
複数のリポジトリがチェックアウトされた際、
親ディレクトリとなるディレクトリを想定しています。
"/"で終わる文字列を設定してください。

[if is_git条件文内](Git利用時のみ)

変数 説明
checkoutURL Gitのリポジトリを指定してください。なお、checkoutURLの"/"でセパレートされた最後の文字列を、プロジェクト名と認識します。
dirPathRepo 解析対象リポジトリをチェックアウトするための親ディレクトリを指定します。
複数のリポジトリがチェックアウトされた際、
親ディレクトリとなるディレクトリを想定しています。
"/"で終わる文字列を設定してください。

[3.2][if is_read_csv条件文内]csv利用時の設定(csv利用時のみ)

変数 説明
dirPathRepo Understandの出力したメトリクスレポート(csv)を配置するディレクトリを指定します。
projectName Understandの出力したメトリクスレポート(csv)のファイル名（拡張子を除く）。

実行時の注意点