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

C#コーディングルール_#22_その他不要なルールを非表示

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

それでは残りの警告をまとめて対応していきたいと思います。

SA1629

まずはSA1629です。

解説のWEBサイトを確認すると,XMLヘッダーのコメントがピリオドで終わっていないという警告となっています。

このように,以前の解説で記載したXMLコメントの「画面1」がピリオドで終わっていないといっています。これは英語圏の文化であり,我々のように日本語でコメント書いている場合は関係がないので,非表示にしましょう。

これで,SA1629が非表示になりました。

SA1633

次はSA1633を見ていきましょう。

標準のファイルヘッダーが無いと警告されています。標準のファイルヘッダーとは,次のようなやつです。

これが必要かどうかは,所属している会社のルールによって異なると思います。私は不要と思うので非表示にします。

SA1642

続いてSA1642です。

コンストラクタのXMLコメントに要約テキストが含まれていないという警告です。要約テキストとは,次のような書き方です。

Initializesで始まるこの文書で,cref=”Form1”の部分をクラス名にすることで,クラスをNewするときのコメントが次のようになります。

こんな感じの定型文で,クラスが生成されるコメントになるようですが,これも英語圏のお話なので非表示とします。

これですべて警告が無くなりました。これまでで,VisualStudioがデフォルトで作成されるファイルの警告はすべて消しましたが,これ以外にも,クラスを作成していく中で,対応が必要な警告がいくつかあるので,次回以降でそのあたりの解説をしていきます。

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