C#コーディングルール

C#コーディングルール_#17_CS1591_XMLコメントなし

これでは引き続き警告を消していきましょう。

今回は,「CS1591_公開されている型またはメンバーのXMLコメントがありません」を見ていきましょう。

CS1591

CS1591の警告の行をダブルクリックします。

Form1のコンストラクタへ飛ぶと思います。「警告としては,ここにXMLコメントがない」といっているので,このコンストラクタに対してXMLコメントを入れます。

XMLコメントの追加

XMLコメントを追加する場合は,「/」スラッシュを3つ書くことで,次のような3行のコメントが自動で生成されます。

この,自動でできた3行の真ん中の行に,そのメソッドに対するコメントを記述します。

このように「画面1」や「コンストラクタ」などのコメントを入れます。

警告の確認

これで,警告が消えているのが確認できると思います。同様の警告が出た場合は,同じ要領でXMLコメントを追記して警告を消してください。今回のようなXMLコメントは,クラスを使用する時に,ガイドとして表示されたりするので,この警告は無視せず,必ず入力するようにしてください。

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人以上が受講している動画コースはこちらからご確認ください