C#コーディングルール PR

C#コーディングルール_#16_SA0001_プロパティのビルドのXMLでファイルを指定しておくと消える

記事内に商品プロモーションを含む場合があります

それでは今回より,スタイルコップの表示している警告を1つずつ消していきたいと思います。ます,ソリューションを右クリックして「リビルド」を行います。

そうすると,私の環境では「エラー一覧」に警告が21個表示されています。

コードでソートする

エラー一覧に警告が表示されたら「コード」列のヘッダーをクリックして,昇順△になるようにソートします。

コードのリンクをクリックする

「SA1200」などのリンクをクリックするとインターネットに接続されていれば,警告理由のサイトに移動できます。

このようなサイトに移動します。このページをGoogleのChromeで開くと,日本語に翻訳ができるので,日本語で読みたい方は,そのほうがいいと思います。

こんな感じで翻訳して,警告の理由を確認し,対応が必要かどうかを判断します。

SA0001の対応

警告理由を翻訳すると,「プロジェクト構成のため、XMLコメント分析は無効になっています」という意味になります。

XMLドキュメントファイルにチェックを入れる

対応方法は次のようになります。

まずWinFormプロジェクトのPropertiesをダブルクリックします。

表示された画面の「ビルド」を選択し,「XMLドキュメントファイル」のチェックボックスにチェックを入れます。この状態で再度ビルドすると,警告は消えます。このチェックを入れることで,XMLドキュメントを別途ツールなどで変換するとヘルプ画面が作れるようになる元となるXMLを吐き出す設定になります。

このような///DDDDなどというXMLコメントをそのままヘルプにする際に必要なXMLファイルが吐き出されるようになっています。今回は使いませんが,このような設定にすることでこの警告は表示されなくなります。

C#コーディングルール
Udemyで販売しているC#のコースを 1つプレゼントします!