マネージ コード用のカスタム コード分析チェックイン ポリシーの実装
コード分析チェックイン ポリシーは、バージョン コントロールにチェックインする前のソース コードに対してチーム プロジェクトのメンバーが実行する必要がある規則のセットを指定します。Microsoft では、コード分析規則を機能区分でグループ化した標準の規則セットを提供しています。チェックイン ポリシーのカスタム規則セットは、チーム プロジェクトに固有のコード分析規則セットを指定します。規則セットは .ruleset ファイルに格納されます。
チェックイン ポリシーはチーム プロジェクト レベルで設定され、バージョン コントロール ツリー内の .ruleset ファイルの場所で指定されます。チーム ポリシーのカスタム規則セットのバージョン コントロール場所に関する制限はありません。
コード分析は、各プロジェクトのプロパティ ウィンドウで、個々のコード プロジェクトに対して構成されます。コード プロジェクトのカスタム規則セットは、ローカル コンピューター上の .ruleset ファイルの場所で指定されます。コード プロジェクトと同じドライブにある .ruleset ファイルを指定した場合、Visual Studio は、プロジェクト構成でファイルの相対パスを使用します。
チーム プロジェクトのカスタム規則セットを作成する際には、チェックイン ポリシーの .ruleset ファイルを、コード プロジェクトの一部ではない特別なフォルダーに格納することをお勧めします。規則ファイルを専用フォルダーに格納すると、ファイルを編集できるユーザーを制限するアクセス許可を適用したり、プロジェクトが含まれるディレクトリ構造を別のディレクトリまたはコンピューターに簡単に移動したりできます。
チーム プロジェクトのカスタム チェックイン規則セットの作成
チーム プロジェクトのカスタム規則セットを作成するには、まず、ソース管理エクスプローラーでチェックイン ポリシーの規則セット用の特別なフォルダーを作成します。次に、規則セット ファイルを作成し、バージョン コントロールに追加します。最後に、規則セットをチーム プロジェクトのコード分析チェックイン ポリシーとして指定します。
[!メモ]
チーム プロジェクト内にフォルダーを作成するには、まず、チーム プロジェクトのルートをローカル コンピューター上の場所にマップする必要があります。詳細については、「ワークスペースの作成と操作」を参照してください。
チェックイン ポリシーの規則セット用のバージョン コントロール フォルダーを作成するには
チーム エクスプローラーで、チーム プロジェクトのノードを展開し、[ソース管理] をクリックします。
[フォルダー] ペインで、チーム プロジェクトを右クリックし、[新しいフォルダー] をクリックします。
ソース管理のメイン ペインで、[新しいフォルダー] を右クリックし、[名前の変更] をクリックし、規則セット フォルダーの名前を入力します。
チェックイン ポリシーの規則セットを作成するには
[ファイル] メニューの [新規作成] をポイントし、[ファイル] をクリックします。
[カテゴリ] ボックスの一覧の [全般] をクリックします。
[テンプレート] ボックスの一覧の [コード分析規則セット] をダブルクリックします。
規則セットに含める規則を指定し、作成した規則セット フォルダーに規則セット ファイルを保存します。
詳細については、「カスタム コード分析規則セットの作成」を参照してください。
規則セット ファイルをバージョン コントロールに追加するには
ソース管理エクスプローラーで、新しいフォルダーを右クリックし、[項目をフォルダーに追加] をクリックします。
詳細については、「バージョン管理の使用」を参照してください。
作成した規則セット ファイルをクリックし、[完了] をクリックします。
ファイルがソース管理に追加され、チェックアウトされます。
ソース管理エクスプローラーの詳細ウィンドウで、ファイル名を右クリックし、[保留中の変更をチェックイン] をクリックします。
[チェックイン] ダイアログ ボックスで、必要に応じてコメントを追加し、[チェックイン] をクリックします。
[!メモ]
チーム プロジェクトに対して既にコード分析チェックイン ポリシーを構成していて、[現在のソリューションの一部であるファイルのみのチェックインを強制] がオンになっている場合、ポリシー エラーの警告が発生します。その場合は、[ポリシー エラー] ダイアログ ボックスで [ポリシー エラーをオーバーライドして、チェックインを続行] チェック ボックスをオンにします。必要なコメントを追加し、[OK] をクリックします。
規則セット ファイルをチェックイン ポリシーとして指定するには
[チーム] メニューの [チーム プロジェクトの設定] をポイントし、[ソース管理] をクリックします。
[チェックイン ポリシー] をクリックし、[追加] をクリックします。
[チェックイン ポリシー] の一覧で、[コード分析] をダブルクリックし、[マネージ コードのコード分析を強制] チェック ボックスがオンになっていることを確認します。
[この規則セットを実行 ] の一覧で、[<ソース管理から規則セットを選択>] をクリックします。
バージョン コントロール内のチェックイン ポリシーの規則セット ファイルのパスを入力します。
パスは、次の構文に従っている必要があります。
**$/TeamProjectName/**VersionControlPath
[!メモ]
パスをコピーするには、ソース管理エクスプローラーで次のいずれかの手順を実行します。
[フォルダー] ペインで、規則セット ファイルが格納されているフォルダーをクリックします。Source ボックスに表示されているフォルダーのバージョン コントロール パスをコピーし、規則セット ファイルの名前を手動で入力します。
詳細ウィンドウで、規則セット ファイルを右クリックし、[プロパティ] をクリックします。[全般] タブで、[サーバー名] の値をコピーします。
コード プロジェクトとチェックイン ポリシーの規則セットの同期
チーム プロジェクトのチェックイン ポリシーの規則セットは、コード プロジェクトのプロパティ ダイアログ ボックスで、コード プロジェクト構成のコード分析規則セットとして指定します。規則セットがコード プロジェクトと同じドライブにある場合、ファイル ダイアログ ボックスでパスが選択されると、相対パスを使用して規則セットが指定されます。相対パスにより、プロジェクトのプロパティ設定を、同じローカル バージョン コントロール構造を使用する他のコンピューターに移植できます。
チーム プロジェクトの規則セットをコード プロジェクトの規則セットとして指定するには
必要に応じて、チェックイン ポリシーの規則セット フォルダーおよびファイルをバージョン コントロールから取得します。
この手順を実行するには、ソース管理エクスプローラーで規則セット フォルダーを右クリックし、[最新バージョンの取得] をクリックします。
ソリューション エクスプローラーでコード プロジェクトを右クリックし、[プロパティ] をクリックします。
[コード分析] をクリックします。
必要に応じて、[構成] の一覧および [プラットフォーム] の一覧のオプションをクリックします。
指定した構成を使用してコード プロジェクトをビルドするたびにコード分析を実行するには、[ビルドに対するコード分析の有効化 (CODE_ANALYSIS 定数を定義)] チェック ボックスをオンにします。
他社のコンポーネントのコードを無視するには、[生成されたコードの結果を表示しない] チェック ボックスをオフにします。
[この規則セットを実行 ] の一覧で、[<参照...>] をクリックします。
チェックイン ポリシーの規則セット ファイルのローカル バージョンを指定します。