2022-06

リーダブルコード

C#リーダブルコード #26_名前を統一するための辞書ツール作成

どのような名前にするとしても,プログラマー全員が統一した名前を付けることが重要です。しかし,それは口で言うほど簡単なことではありません。毎日黙々と仕事をしているプログラマーが変数の名前を1つ付けるたびに,みんなに聞くことは現実的ではありませ...
リーダブルコード

C#リーダブルコード #52_リーダブルコードまとめ

コードに想いを込める まずは,コードに思いを込めるということです。それはメソッド名だったり,変数名だったり,クラス名だったりします。どういったつもりで書いているのかというのを,他のプログラマーや,未来のうろ覚えの自分に対して伝えるメッセージ...
リーダブルコード

C#リーダブルコード #51_未実装部分はTODOを書く

未実装部分で,後からコーディングしようと思っている部分は,TODOコメント書いていただければOKです。 private void CreateProduct() { var p = new Product(1, "", 0, 0); //T...
リーダブルコード

C#リーダブルコード #50_コメントで悪いコードを取り繕うことはできない

今回は「コメントで悪いコードを取り繕うことはできない」というお話をしていきたいと思います。 コメントに関するその他 コメントで悪いコードを取り繕うことはできない ここまで読んでいただいた方にはよくご理解いただけているとは思いますが,判りづら...
リーダブルコード

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

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

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

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

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

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

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

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

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

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

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

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