C#のコードスタイルをチェックできるStyleCopをVisual Studioで使用するには？

StyleCopはC#をVisual Studioで使用する上で、コードをルールや規則に基づいてチェックしてくれる便利なツールです。ここでは、StyleCopについての概要からVisual Studioでの設定方法まで説明します。

システム
エンジニア

コードの整形ツールということは、FxCopと同じようなツールなのでしょうか？

プロジェクト
マネージャー

よく似たツールとしてFxCopが挙げられますが、内容は異なります。用途によって使い分けるのが一番良いですね。

StyleCopの概要

「StyleCop」はC#に向けた静的コード分析のオープンソースツールです。自身で設定したルールや規則に基づいて違反したコードが存在した場合に警告を出すことができます。

そして、冒頭でもあったように、StyleCopと似たツールに「FxCop」が存在します。FxCopはコンパイルされた後、コードに対してチェックを行うため、コンパイル前の細かい規約についてのチェックは不可能ですが、デザインガイドに基づいた言語に依存しないチェックを行う点では便利です。

しかし、C#におけるコーディングルールをチェックする上では、StyleCopの方が適しています。ヘッダーの設定や行間の空行の数、中括弧の位置や空白を入れる、入れないといったコーディングのスタイルに注目して品質を確認します。チェックした結果は、エラー一覧ウィンドウに警告として表示されます。

StyleCopの導入とVisual Studioでの設定方法

1. CodePlexのサイトから最新版をダウンロード・インストールします。
2. MSIファイルをダウンロードしたらダブルクリックし、インストールします。
3. ライセンスに同意して次に進み、インストールを完了します。

次にVisual Studioでの設定方法です。

StyleCopのインストールが完了したらVisual Studioを起動します。

1. Visual Studioの「ソリューションエクスプローラー」のプロジェクトを右クリックしてコンテキストメニューを表示します。
2. 「Run StyleCop」を実行します。
3. 「エラー一覧」に警告が表示されます。

Visual Studioでの設定は以上ですが、プロジェクトを右クリックしたときに「StyleCopSettings」を選択することでStyleCopの設定ツールを起動することも可能です。

システム
エンジニア

FxCopは出来上がった後のものをチェックするもので、StyleCopは出来上がる前のものをチェックできるのですね。細かい規約をチェックしたいときはStyleCopを使うようにしてみます。

プロジェクト
マネージャー

そうですね。チームで開発するときでも、時間短縮のメリットが得られるので便利ですよ。

チームの開発時に便利なStyleCop

StyleCopを使用するとコーディング規約のチェックを自動化できるので、設定したルールに基づいてコーディングスタイルをチーム内で整えることができます。また、検出された問題を自動的に修正する機能も提供されているため、開発時間の短縮にもつながります。