C#コーディングルール

C#コーディングルール_#13_StyleCopAnalyzersについて

Udemyで公開しているC#のコースを1つ無料でプレゼントしています。こちらから確認してください。

前回まででローカルルールのお話は終わりです。今回からはStyleCopAnalyzers(スタイルコップアナライザー)というツールのお話をしていきます。

StyleCopAnalyzersとは?

スタイルコップを使えば「コンストラクタ」と「プロパティ」ではどちらを上に書くか?と悩まなくとも警告してくれる。これでみんなが嫌な思いをせず,コードを修正してくれるようになった。

StyleCopAnalyzersとは,コードを解析して,ルールに違反している箇所を警告として教えてくれるツールです。例えば「プロパティ」と「コンストラクタ」ではどちらを上に書くのが正しいか?とか,XMLコメントが漏れている箇所とか,そういったものを全部まとめて警告にしてくれます。

このツールのおかげで,チームのメンバーは何も言わなくても,正しいコーディングルールでコードを書くようになってくれました。毎回コードレビューをして,いちいち指摘しなくても,まちがった箇所はツールが「間違っている」と指摘してくれるおかげで,誰も嫌な思いをせずにみんな修正してくれるようになったのです。

コードレビューは非常に重要ですが,指摘するほうもされるほうもいい気持ちにならないこともあります。本当は「コードを憎んで人を憎まず」なので,良くないコードはあまり気にせずただ直せばいいだけなのですが,こちらの言い方が悪かったり,受け取る人次第では,人格が否定されたように感じる人もいないわけではありません。

チームのリーダーとしては,そういった思いをさせないように努めないといけないのですが,このツールが一定のレベルにまではコードを押し上げてくれるといった感じで,コードレビューでは,そういったレベルではなく,仕様上のコアなレベルのコードレビューに集中できるようになったという事です。

このツールはNugetから無料で使用できるので,まだ使っていない人は是非使ってみてください。次回よりこのツールの使い方を説明していきます。

Udemyで公開しているC#のコースを1つ無料でプレゼントしています。こちらから確認してください。