C#コーディングルール

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

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

プロパティの作成

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

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

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

SA1623

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

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

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

これで警告が消えます。

C#コーディングルール

■動画でのレッスンをご希望の方はこちらからご確認ください

#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_最後に

■動画でのレッスンをご希望の方はこちらからご確認ください