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

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

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

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

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

CS1591

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

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

XMLコメントの追加

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

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

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

警告の確認

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

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