Visual StudioでC#などのコーディング規約をチェックしてくれるStyleCopを利用しているのですが、規約No.「SA1600」、「Elements must be documented.」、ソースの要素にはすべてXMLコメントをつける必要があるという規約をONにすると、プライベート宣言したフィールド*1についてもコメントが必須になってしまいます。フィールド自体を乱用するのもよくないのですが、実際、ことごとくフィールド宣言されているようなひどいソースもあることからこの規約をそのままONにするとちょっとコーディングが回りません。
なんとかプライベートなフィールドは対象から外せないか調べてみました。検索キーワード「StyleCop Sa1600 private fields」で検索したところ、下記のstackoverflowのページがヒット。
StyleCopの設定を開き、Rulesタブにある「Documentation Rules」をマウスで選択すると、右側の「Detailed settings」に
- Ignore privates
- Ignore internals
- Include fields
という項目があります。上2つはチェックがOFF、下の「Include fields（フィールドを対象として含める）」がONになっているので、この項目をオフにすると……うまくいきました。まさかここで設定できるとは……。
なお、StyleCop Analyzerの場合はおそらく少し違うと思うので注意してください。
Instant StyleCop Code Analysis How-to (English Edition)
- 作者: Franck LEVEQUE
- 出版社/メーカー: Packt Publishing
- 発売日: 2013/05/23
- メディア: Kindle版
- この商品を含むブログを見る
- 作者: 向山隆行,片山優司,阿部順一,寺田和朗,畑中良平,電通国際情報サービス
- 出版社/メーカー: 技術評論社
- 発売日: 2010/12/10
- メディア: 単行本（ソフトカバー）
- 購入: 1人 クリック: 43回
- この商品を含むブログ (2件) を見る
*1:フィールド: クラスの直下で宣言する変数。privateならクラス内でどこからでも参照可能。
![宝石の国（9） （アフタヌーンKC） [ 市川 春子 ]](https://thumbnail.image.rakuten.co.jp/@0_mall/book/cabinet/1015/9784065131015.jpg?_ex=128x128 "宝石の国（9） （アフタヌーンKC） [ 市川 春子 ]")
![わかばちゃんと学ぶGit使い方入門 [ 湊川あい ]](https://thumbnail.image.rakuten.co.jp/@0_mall/book/cabinet/2174/9784863542174.jpg?_ex=128x128 "わかばちゃんと学ぶGit使い方入門 [ 湊川あい ]")
