C#

リーダブルコード

C#リーダブルコード #49_コードを読んだ人が「えっ?」と思うことが予想される場所にだけコメントを付ける

今回は「コードを読んだ人が「えっ?」と思うことが予想される場所にだけコメントを付ける」というお話をしていきたいと思います。 1.1   不可解な仕様 例えば次の①のようなif文があった場合「p.ProductName == 'A'」,こうい...
リーダブルコード

C#リーダブルコード #48_メソッド内にコメントを書かない

前回の続きで,メソッド内にどうしてもコメントを書きたい場合の対処法を解説していきます。 わかりづらいコードはメソッド化してメソッド名で表現する 先述のように,メソッド内にコメントは書かない方がよいのですが,それでもどうしても書きたくなるほど...
リーダブルコード

C#リーダブルコード #47_メソッド内にコメントを書かない

今回は「メソッド内にコメントを書かない」というお話をしていきたいと思います。 コメントを書く理由は?意味の分からないメソッドだから? 昔はよくメソッドの中にコメントを書いていましたが,現状はメソッドの中のコメントは基本的に書かないことを推奨...
リーダブルコード

C#リーダブルコード #46_クラス名で継承元や特性を表現する

今回は「クラス名で継承元や特性を表現する」というお話をしていきたいと思います。 クラス名にパターン名やアルゴリズム名を含める クラス名の語尾に世の中で浸透しているデザインパターン名や,アルゴリズム名を付けるのは良いことです。なぜなら,それら...
リーダブルコード

C#リーダブルコード #45_クラス名は名詞か名詞句で命名する

今回は「クラス名は名詞か名詞句で命名する」というお話をしていきたいと思います。 GOOD:クラス名は名詞か名詞句で命名する クラスは名詞か名詞句で付けるのが基本です。名詞というのは例えば,CatやCustomerなどが名詞になります。 名詞...
リーダブルコード

C#リーダブルコード #44_クラス名はソリューションエクスプローラーで並べることを意識する

今回は「クラス名はソリューションエクスプローラーで並べることを意識する」というお話をしていきたいと思います。 GOOD:クラス名は大項目中項目小項目の順に書く クラス名は,大項目,中項目,小項目の順に書くことで,ファイル名としてソリューショ...
リーダブルコード

C#リーダブルコード #43_アクセス修飾子とsealedを付ける

ここからはクラスに関してのリーダブルコードを解説していきます。ここではまず,クラスのアクセス修飾子を付けるということと,sealedキーワードを付けましょうということを解説していきます。 BAD:アクセス修飾子がない クラスにアクセス修飾子...
リーダブルコード

C#リーダブルコード #42_リージョンで区切らない

今回はリージョンで区切らないというお話をしていきたいと思います。 リージョンとは リージョンとは#regionと#endregionというキーワードで囲むことで,エディター上でコードの開閉をすることが出来る機能です。 #region プロダ...
リーダブルコード

C#リーダブルコード #41_重複をなくす

今回は「コードの重複をなくす」というお話をしていきたいと思います。 コードの重複をなくした方がいいのは,新人プログラマーでも,なんとなく理解しているはずです。今回は,重複コードが生まれるタイミングと,それの対策について解説していきます。 重...
リーダブルコード

C#リーダブルコード #40_無駄に変数に入れて返却しない

今回は「無駄に変数に入れて返却しない」というお話をしていきたいと思います。 BAD:無駄に変数に入れて返却している 次のように,Productをreturnする場合に,一旦result変数に退避してからresultをreturnする書き方は...