リーダブルコード

C#リーダブルコード #11_メソッドはできるだけ早く抜ける_返却する値を無駄に変数に入れない

今回は,「メソッドはできるだけ早く抜ける」というお話をしていきたいと思います。

enumの追加

今回の解説で使うための次のConditionという名前のenumをObjects.csなどに作成します。どこかのクラスに記述するのではなく,namespaceのReadableの直下に記述していただければOKです。

BAD:比較が多すぎてNG

先ほど作成したCondition使用して判定するメソッドの例です。

この例では,SettingかStopかErrorの時にTrueが返却されるようになっていますが,こういった,複数の判断を一度にする場合は,以前bool型の判断のところで解説した通り,バグの原因になるため,できるだけ1つずつの判断にした方が言いわけです。

BAD:返却するboolを変数に入れて最後にリターンする

複数の判断を1つずつの判断に変更することで,バグが入り込みにくくなりますが,次のように返却するbool型の変数に結果を入れて,最後に返却するような例を見てみましょう。

この例では,複数の判定を1つずつするように変更されていますが,resultという変数に結果を一度入れて,最後にreturnしています。この場合,バグの調査などでこのメソッドを誰かが読まないといけない場合,例えば①の部分にヒットした場合も,そのあとの処理を読まないといけません。本来はSettingにヒットしたのだから,Trueを返却して終わればいいのですが,resultに入れられているので,②の部分などで,resultの値が変更されていないかを確認したり,③の部分でresultがreturnされていることを確認したりする必要があります。要するに,必ず最後まで読まないといけないメソッドになってしまっているということです。

GOOD:メソッドはできるだけ早く抜ける

前述の通り,返却する値を,result変数に入れる必要はない場合は,できるだけ早く抜けた方が,読む側としては短いスコープで読めるため,より良いコードといえます。

①のように,SettingにヒットしたらすぐにTrueを返却することで,トレースしているプログラマーからしたら,ここでこのメソッドは読み終わることができます。本当にヒットしなかった時のみ,最後の行まで読むことになり,デバッグ中のプログラマーとしては,大変読みやすくなります。ですので,複数の判定を一度にしない,ということに加えて,ヒットしたら,すぐに抜けるということを意識してください。ただ,ヒットした後に,何かしら値を加工する必要がある場合は,当然result変数などで受けて,加工するなどの処理が必要なのは,念のため補足しておきます。

コードは書くより読む方が多い

プログラマーを始めたころはあまり気が付かないかもしれませんが,プログラムというのは,書くより,読まれる機会の方が,断然に多いのです。書くのは,担当プログラマーが書く1回ですが,読む機会は,デバッグをするプログラマー全員が,バグ修正や,調査などのたびに,何度も読まれる機会があります。ですので,プログラムコードというのは,書く人間の気持ちよりも,読む人間に寄り添った書き方をするべきです。書く人間の仕事はこのメソッドを作ることですが,読む人間は,大量のメソッドを読む中の1つのメソッドがこのメソッドなわけです。だから,1つ1つのメソッドが,短いスコープで読めるように工夫してあげることが,寄り寄りプログラムであり,よりよいプロジェクトであるといえます。

リーダブルコード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で読み放題です