コード設計学習１ 命名

このブログについて

最近システム設計に興味を持ち、特にコード設計について学んだことをまとめます。
自分の今後の戒めも込めて。

命名について

見た目は動いているコードでも、命名が適切でないと構造が見えずバグの温床になります。
今回は「命名」に注目して、良いコードと悪いコードを比較してみます。

悪いコード例

var a = GetData(b);
var c = Process(a);
DoIt(c);

動作はしているかもしれませんが、何をしているのかまったく伝わりません。
命名が意味を失っていると、構造の意図を読み取れず、
「修正するたびに推測ゲームが始まる」状態になります。

良いコード例

var user = userRepository.GetById(userId);
var updatedUser = user.UpdateEmail(newEmail);
userService.Save(updatedUser);

名前を整えることは、構造を明確にすること。
人間の脳は「構造を理解できる名前」を手がかりにコードを把握します。
命名の混乱は、コード全体の理解コストを急激に上げます。