12章コードに思いを込める

おばあちゃんがわかるように説明できなければ、本当に理解したとは言えない。

——アルバート・アインシュタイン

誰かに複雑な考えを伝えるときには、細かいことまで話しすぎると相手を混乱させてしまう。自分よりも知識が少ない人が理解できるような「簡単な言葉」で説明する能力が大切だ。自分の考えを凝縮して、最も大切な概念にすることが必要になる。これは誰かに理解してもらうだけでなく、自分の考えをより明確にすることにもなる。

コードを読み手に「プレゼント」するときにも、これと同じ能力を使うべきだ。ソースコードというのは、プログラムの動作を説明する最も大切な手段だとぼくたちは考えている。つまり、コードも「簡単な言葉で」書くべきなのだ。

本章では、コードをより明確にする簡単な手順を使う。

  1. コードの動作を簡単な言葉で同僚にもわかるように説明する。
  2. その説明のなかで使っているキーワードやフレーズに注目する。
  3. その説明に合わせてコードを書く。

12.1 ロジックを明確に説明する

以下は、あるウェブページから取ってきたPHPのコードの一部である。セキュアページを扱うコードの最上部にあったものだ。ユーザにページを閲覧する権限があるかどうかを確認して、もし権限がなければ、権限がないことをユーザに知らせるページに戻す。

$is_admin = is_admin_request(); if ($document) { if (!$is_admin && ($document['username'] ...

Get リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック 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.