C#コーディングルール

C#コーディングルール_#27_プロパティのXMLコメント

今回はプロパティのXMLコメントに関するルール解説していきます。

プロパティの作成

前述の通り,プロパティはパスカルで書きます。アッパーキャメルとも言います。1文字目大文字で始めないと警告になります。次のような感じでProductNameというプロパティを書いてみましょう。

このままだとXMLコメントが無いので,警告になるので,XMLコメントを追記します。

このように,XMLコメントを書くと,また別の警告が出ます。

SA1623

SA1623という警告が出ます。どうやらプロパティは決まった形のXMLコメントを書かないと警告になるようです。WEBサイトで調べると次のように警告されています。

ドキュメントテキストが,何やら一致しない的な警告であることがわかります。

このような感じで,定型文的に書かないと警告なるのですが,これを日本語に翻訳して,「顧客の名前を取得または設定します」としても警告は消えないので,コメントはこのような感じで書いてもらったらいいのですが,警告自体は日本語には合わないという事で,非表示にする必要があります。

これで警告が消えます。

C#コーディングルール