リーダブルコード

C#リーダブルコード #19_意図が明確な名前を付ける

今回は意図が明確な名前を付けるというお話をしていきます。

1.1   BAD:どんな日付を求めているか分かりづらい

次のような現在日時をチェックするメソッドがあったとします。

DateCheckというメソッド名では現在日時をチェックするということがわからないし,dateという引数名では,現在日時を求めているということが理解できません。

1.1   GOOD:現在日時を求めていることが分かる

次のように,CurrentDateCheckやcurrentDateという名前にすることで,現在日時を求めていることが理解できます。

1.1   クラス分割がうまくできている場合は例外

クラス分割がうまくできている場合,例えばCurrentDateクラスの中にあるdate変数であればそれが現在日時であることがわかるということはあるので,うまくクラス分割ができている場合はこの限りではありません。そうではなく,画面クラスなど,色々なクラスを使っている中で,date変数としてしまうと,「何の日時?」となってしまうので,その辺りは考慮してください。

1.2   IdやNameも注意する

IdやNameという命名も,何のID?,何の名前?ということになるので,IdはProductIdやNameならPorductNameなど,どういった用途で使うかを付けた方がいいです。これはC#だけでなく,データベースの列名を付ける時も同じですね。例えばProductテーブルにIdという列があるのに,StockテーブルにもIdがあり,実態はProductIdとStockIdという意味で使用する場合は,DBの列名にもProductIdやStockIdと命名した方がよいです。そうすれば,それをC#で取り込んだ後も,ProductIdとStockIdという命名で全体が動作してわかりやすいですね。DBの場合テーブルが別であれば,同じ名前でも命名できますが,同じ用途で使用しない場合は,別の名前を付けた方が,アプリケーション全体が安定します。

リーダブルコードC#

C#を正しい3層構造で造れてますか?

非売品コースを受け取る

#01_はじめに
#02_プロジェクトの作成
#03_右に長いコードを書かない_隣のとなりまでしか訪ねない
#04_隣のとなりまで_右スクロールより縦スクロールの方がいい
#05_IFとELSEがある時は肯定系をIF否定形をELSEにする
#06_比較する時は変数を左_定数を右にする
#07_複数の比較を1回のif文でやらない
#08_booの比較でTrueやFalseを書かない
#09_否定の否定はしない
#10_型チェックはasを使う
#11_メソッドはできるだけ早く抜ける_返却する値を無駄に変数に入れない
#12_対象外の時はすぐに抜ける
#13_都合が悪いケースはガードする
#14_必ずやりたい処理はfinallyを使う
#15_比較演算子はできるだけクラスにさせる
#16_ifの中括弧の省略はしない
#17_if文のリーダブルコードまとめ
#18_名前の付け方
#19_意図が明確な名前を付ける
#20_名前は素直に付ける_連想ゲーム的な名前を付けない
#21_1つの事しかしていなければ短い名前でも理解できる
#22_長いクラス名の扱い方
#23_単数形と複数形で表現する
#24_対になる言葉の組み合わせを決めておく
#25_業務で使う名前は統一する
#26_名前を統一するための辞書ツール作成
#27_メンバー変数にアンダーバーを付ける
#28_ハンガリアン記法を使わない
#29_メソッド内の変数をメソッド最初に全部宣言しない
#30_メソッド内の変数は直前に宣言する
#31_ループの変数はループ内で宣言する
#32_変数を使いまわさない
#33_boolの戻り値はどちらがTrueかをわかるようにする
#34_解放が必要なオブジェクトにはusingを使う
#35_varを推奨する場合
#36_メソッド名の付け方
#37_voidとFunctionを意識する
#38_インテリセンスを意識した名前にする
#39_生成メソッドはCreate_型変換はToを使う
#40_無駄に変数に入れて返却しない
#41_重複をなくす
#42_リージョンで区切らない
#43_アクセス修飾子とsealedを付ける
#44_クラス名はソリューションエクスプローラーで並べることを意識する
#45_クラス名は名詞か名詞句で命名する
#46_クラス名で継承元や特性を表現する
#47_メソッド内にコメントを書かない
#48_分かりづらい部分はメソッド化をしてメソッド名で想いを伝える
#49_コードを読んだ人が「えっ?」と思うことが予想される場所にだけコメントを付ける
#50_コメントで悪いコードを取り繕うことはできない
#51_未実装機能はTODOコメントを書く
#52_リーダブルコードまとめ

ピーコックアンダーソンの書籍はすべてKindleunlimitedで読み放題です