C#コーディングルール

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

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

SA1629

まずはSA1629です。

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

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

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

SA1633

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

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

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

SA1642

続いてSA1642です。

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

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

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

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

C#コーディングルール

■4700人以上が受講している動画コースはこちらからご確認ください

#01_はじめに
#02_名前の付け方
#03_名前付けのガイドライン
#04_パスカルケースとキャメルケース
#05_パスカルとキャメルの内訳
#06_パスカルとキャメルの実演
#07_2文字の略語は大文字にする
#08_名前空間のガイドライン
#09_ローカルルールについて
#10_private変数にアンダーバーを付ける
#11_コントロールの名付け
#12_クラス名とファイル名の名づけ
#13_StyleCopAnalyzersについて
#14_StyleCopAnalyzersのインストール
#15_ネームスペースの調整
#16_SA0001_プロパティのビルドのXMLでファイルを指定しておくと消える
#17_CS1591_XMLコメントなし
#18_SA1101_thisが付いていない
#19_不要なルールを非表示にする方法
#20_SA1200_usingの場所
#21_SA1400_アクセス修飾子が明示的に定義されていない
#22_その他不要なルールを非表示
#23_コンストラクタとデストラクタを作成
#24_Private変数とパラメータ変数の命名
#25_中括弧の省略禁止と改行
#26_コメントはスラッシュ4つ
#27_プロパティのXMLコメント
#28_コンストラクタやプロパティの書く順番
#29_アクセスレベルを加味した書く順番
#30_インタフェースのIとファイル名の不一致
#31_最後に

■4700人以上が受講している動画コースはこちらからご確認ください