4章 美しさ
プログラミングの時間のほとんどはコードを読む時間だと言っても過言ではない。
美しいコードは、さっと流し読みができて誰にとっても使いやすいコードである。
本章では、コードを読みやすく(美しく)するための余白・配置・順序について説明する。
縦の線をまっすぐにする
以下のようなコードがあるとする。
$details = $_POST['details'];
$location = $_POST['location'];
$phone = $_POS['phone'];
$email = $_POST['email'];
$url = $_POST['url'];
上から3つ目の定義でタイプミスをしている。以下のようにコードの縦のラインが揃っていた方が、読みやすくミスがあった場合にも気が付きやすい。
$details = $_POST['details'];
$location = $_POST['location'];
$phone = $_POS['phone'];
$email = $_POST['email'];
$url = $_POST['url'];
一貫性と意味のある並び
以下の変数の定義は、どんな順番で並べてもコードの正しさに影響を及ぼすことはない。
$details = $_POST['details'];
$location = $_POST['location'];
$phone = $_POS['phone'];
$email = $_POST['email'];
$url = $_POST['url'];
であれば、ランダムに並べるのではなく、意味のある順番で並べる方が望ましい。
- 対応するHTMLフォームの要素と同じ並び順にする。
- 重要なものから順に並べる。
- アルファベット順に並べる。
また、同じ変数を再定義するような場合には、最初に定義した時と同じ順番で定義して一貫性を持たせた方が良い。
もし仮に一貫性を持たせなかった場合、余計な混乱を招く可能性がある。
$details = htmlspecialchars($details, ENT_QUOTES, "UTF-8");
$phone = htmlspecialchars($phone, ENT_QUOTES, "UTF-8"); //$locationはどこ?
$email = htmlspecialchars($email, ENT_QUOTES, "UTF-8");
$url = htmlspecialchars($url, ENT_QUOTES, "UTF-8");
$location = htmlspecialchars($location, ENT_QUOTES, "UTF-8");//なぜ$locationが下にくるのか?