StyleCopとは

ソースコードのコーディングルールをチェックするツールです。

インストール

SourceForgeやCodePlexで公開されており、CodePlexではmsiインストーラが配布されています。
下記はCodePlexのmsiインストーラによる手順です。

※インストールする際は、日本語化するつもりであればv4.4.0.9をインストールしましょう。

※インストール媒体はこちらにあります。（本家サイト[CodePlex]です）

インストール手順

msiインストーラのウィザードに従ってインストールするだけです。
特に選択項目はありません。

使用方法

Visual Studio Express Edition ではアドオンが使えないので統合できません。
・・・だからといってExpressで使えないわけではありません。
プロジェクトファイル(csprojファイル)を書き換えて使用します。
プロジェクトファイルに下記のように設定を追加します。

<Import Project="$(ProgramFiles)\MSBuild\Microsoft\StyleCop\v4.4\Microsoft.StyleCop.targets" />

追加場所はルートのProjectタグ直下で良いです。

しかしこのままではビルド時に実行されるようになるため、インストールされていない環境ではエラーが発生してしまいます。

複数人で開発する場合は全員の環境にStyleCopをインストールしておく必要が発生しますが、

下記のように設定することでStyleCopがインストールされていない環境でもビルドできるようになります。

<Import Condition="Exists('$(ProgramFiles)\MSBuild\Microsoft\StyleCop\v4.4\Microsoft.StyleCop.targets')"
        Project="$(ProgramFiles)\MSBuild\Microsoft\StyleCop\v4.4\Microsoft.StyleCop.targets" />

Condition属性によってファイルが存在しない場合ビルドに組み込まないようにしています。

Condition属性については下記を参照。

MSDN：Import 要素 (MSBuild)

MSDN：MSBuild の条件

使用時のイメージ

次の様になります

※左が英語版使用時、右が日本語化後です。

英語版でも使えないことはないですが、開発効率が下がるので日本語化しましょう。

日本語化

http://sourceforge.jp/projects/oss-ja-jpn/releases/?package_id=11170

上記サイトにある、stylecop-f1a1f7cd9f80-ja-1.2.zipをダウンロードしましょう。

README_ja.txtに日本語化の手順が書かれているのでそれに従い適用します。

コーディングルールのカスタマイズ

コーディングルールカスタマイズ用のGUIツールが同梱されています。

このツールはスタート＞すべてのプログラムに登録されないようです(Windows Vista Homeにて確認)。

GUIツールは下記ファイルです。

%ProgramFiles%\MSBuild\Microsoft\StyleCop\v4.4\Settings.StyleCop

起動イメージ

※左が英語版使用時、右が日本語化後です。

参考

このページは以下のページを参考に作られています。

ネスケラボ - StyleCop（C#のコードスタイルチェック）

なか日記 - StyleCopの日本語化（成功）

また、Wikiもあるようですので参考にどうぞ。

漫坊亭@ウィキ