2020-04

C#コーディングルール

C#コーディングルール_#31_最後に

以上がスタイルコップアナライザーの解説となります。このスタイルコップアナライザーのいいところは,ツールが警告してくれる点です。コードレビューの際に人間が指摘すると,どうしても角が立つし,快く思わないメンバーもいます。誰だって指摘されるのはい...
C#コーディングルール

C#コーディングルール_#30_インタフェースのIとファイル名の不一致

今回はインタフェースの命名のルールと,ファイル名とクラス名が同じでないといけないという2つのルールを解説していきます。 インタフェースの命名 インタフェースの命名ルールはインタフェース名の頭に「I」を付けるというものがあります。頭にIを付け...
C#コーディングルール

C#コーディングルール_#29_アクセスレベルを加味した書く順番

前回はプロパティとかコンストラクタとかどちらを上に書くべきか?といった内容をご説明しました。今回もコード内順序のお話ですが,アクセスレベルを加味したコード内順序のお話になります。アクセスレベルとはpublicなどのアクセス修飾子の事です。 ...
C#コーディングルール

C#コーディングルール_#28_コンストラクタやプロパティの書く順番

今回は,クラス内に書く,コンストラクタやプロパティなどの,書く順番に関するルールを解説していきます。この警告のおかげで,決められた順序で書かないと警告になるので,チーム全体が同じ順番で記述することができます。 SA1201 例えば次のように...
C#コーディングルール

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

今回はプロパティのXMLコメントに関するルール解説していきます。 プロパティの作成 前述の通り,プロパティはパスカルで書きます。アッパーキャメルとも言います。1文字目大文字で始めないと警告になります。次のような感じでProductNameと...
C#コーディングルール

C#コーディングルール_#26_コメントはスラッシュ4つ

今回はコメントに関するルールを解説していきます。 スラッシュ2つでコメントを書く C#ではスラッシュ2つでコメントが記述できますが,そのまま書くと警告が出ます。 SA1005 スラッシュ2つに続けてコメントを記載するとSA1005の警告が出...
C#コーディングルール

C#コーディングルール_#25_中括弧の省略禁止と改行

今回は中括弧に関するルールと,改行に関するルールを解説していきます。 If文やfor文を中括弧なしで書いてはいけない If文を1行や2行で書いた場合 C#ではif文を1行で書くことができます。 if (productId == 0) ret...
C#コーディングルール

C#コーディングルール_#24_Private変数とパラメータ変数の命名

今回はPrivate変数とパラメータ変数の名前のルールに関して解説していきます。 Private変数 ProductIdというように,private変数の頭文字を大文字にするとSA1306の警告が出ます。 SA1306 この警告をWEBサイ...
C#コーディングルール

C#コーディングルール_#23_コンストラクタとデストラクタを作成

これではここからは,色々クラスを作成しながら,スタイルコップアナライザーのルールの確認をしていきたいと思います。 Objectsフォルダーの作成 WinFormプロジェクトを右クリックして,「追加」「新しいフォルダー」の順に選択し,フォルダ...
C#コーディングルール

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

それでは残りの警告をまとめて対応していきたいと思います。 SA1629 まずはSA1629です。 解説のWEBサイトを確認すると,XMLヘッダーのコメントがピリオドで終わっていないという警告となっています。 このように,以前の解説で記載した...