ルール18コードに自らの物語を語らせろ
本書では、コードを読みやすくすることに重点を置いている。コードの振る舞いを余計な抽象化で隠さないように注意したり、適切な名前を選んだり、問題に対して一番単純で実行可能なアプローチを選んだり、コードを読みやすくするためにやっていることは様々だ。読みやすいコードを書くことで、他のことが何もかも、もっとスムースに進むようになる。ぼくらはみんな、コードを読んだりデバッグしたりするのに、コードを書く時間よりずっと多くの時間をそもそも割いているからだ。コードをデバッグする際に、そのコードが何を達成しようとしてるかすぐ分かる方法があると、何が問題か理解するのがずっと楽になる。
以上のことは、チームの一員として取り組んでいるプロジェクトには特に当てはまるが、1人のプロジェクトでも同じことが言える。それなりの規模のあるプロジェクトを何週間、何か月、ことによると何年もかけて1人で進めていると、昔書いたコードに再び詳しくならなきゃいけない羽目になる。そういうコードを書いた当時に頭の中で考えていたことは、どんなものだろうが全部消え去っていて、残っているのはコードそのものだけだ。この時点で、集団でやってるプロジェクトでの同僚とほとんど同じ立場に自分も置かれていることになる。そうなると、コードが何をしてるのか(あるいは何をしようとしてるのか)、読んで整理しなきゃいけない。
こういう話を別の角度から考えると、要は、「未来の自分」とは「他人」なのだ。
プロジェクトが1日か2日で片付いて放り捨てられるようなものでもない限り、自分のコードに他人として戻ってくるのを予期しておかなきゃいけない。「未来の自分」のために便宜を図って、読みやすいコードにしておこう。
自分が書いたコードの一部を誰かに見せて説明していく場合を想像してみよう。自分のチームがコードレビューをやっているなら(コードレビューはやるべきだ。 ...
Get ルールズ・オブ・プログラミング ―より良いコードを書くための21のルール now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.