書籍「リーダブルコード」で初学者におすすめの実践的なテクニックを学ぶ

この書籍のテーマは「読みやすいコード」です。

プログラミングの命名においては、どれだけ読みやすいコードを書くかということが大事になってきます。

読みやすいコードを書くことでメンテナブルなコードになるので、自分だけではなく、全体で共有しやすいコードが出来上がっていくからです。

この書籍が教えてくれることは、以下のことです。

  • いい名前をつける
  • 適切なコメントをつける
  • 意味のある単位に分割する
  • 綺麗に整形する

このような基本的なことを着実に身につけるための実践的なテクニックが詰まっているのです。

著:Dustin Boswell, 著:Trevor Foucher, 解説:須藤 功平, 翻訳:角 征典
¥2,640 (2021/11/21 02:47時点 | Amazon調べ)

この記事は、書籍「リーダブルコード」の要約や抜粋を含みます

面白いコード = 最悪なコードの事例

これはSEの親父から聞いた話です。

前任者のソースコードをみたところ、変数名がアイドル名になっていたらしいです(笑)。

$seikoとか$harukoとか?

年代が違うのでよくわかりませんが・・。

これではその変数名を使って何をしているのか、さっぱり分からないですよね。

自分だけ理解できるコードというのは、基本的に好まれません。

変数の名前に情報を詰め込むということ

名前を見るだけで、その変数はどんな役割を持つのかといったことが分かると読みやすいですよね。

この書籍では次のようなことが推奨されています。

  • 具体的な名前を使って、物事を詳細に説明する
  • 変数名に大切な情報を加える(例:raw_や_msなど)
  • スコープの大きな変数には、長い名前をつける
  • 大文字やアンダースコアなどに意味を含める

明確な単語を使う

例えばgetではなく、downloadやfetchなど、状況に合わせた変数名を付けると理解できやすいですよね。

汎用的な名前を避ける

tmpなどの名前は、明確な理由がない限り付けない方が良いでしょう。

tmpだけを使うと、ファイルなのかファイル名なのか、データなどかが分からないですよね。

その変数にとって本当に大切なことが「一時的な保管」などという明確な理由がある場合は別として、これらの名前は避ける必要があります。

jQueryのライブラリ関数を呼び出した時には、変数明の頭に$をつける

例)

const $all_images = $("img");

価値のあるコメントを書く

コードからすぐに分かる情報をコメントに書くのは悪手だと本書は言います。

ただ、コードからすぐに分かる情報であっても、コードを読むよりコメントを読んだ方が早く理解できる場合は、コメントに書く方が良い場合もあります。

価値のあるコメントとは、コードを書いているときの考えを記録すること

優れたコメントというのは、「考えを記録する」ためのものである。
コードを書いているときに持っている「大切な考え」のことだ。

例えば、下記のような事例が上げられると本書は言います。

// このクラスは汚くなってきている
// サブクラス’ResourceNode’を作って整理した方が良いかもしれない

コードの欠陥にコメントを付ける

コードは進化の過程で、欠陥を生む運命にあります。

ここで紹介されている記法は次の通りです。

記法典型的な意味
TODO:後で手をつける
FIXME:既知の不具合があるコード
HACK:あまり綺麗じゃない解決策
XXX:危険!大きな問題がある

こういったコメントを書くことで、コードの品質や状態を知らせたり、さらには改善の方向を示したりすることができると本書は言います。

まとめ

読みづらいコードやコメントを書くと、そのコードの保守管理が非常に大変になります。

「自分だけが使うから別にいいや」というコードも中にはあるかもしれません。

ですがそのコードを書いているのは、「今の自分」です。

将来そのコードを見返したときに、「なんであの時あんなコード書いちゃったんだろう」と後悔しないよう、コーディングの基本能力であるリーダブルなコーディングは非常に重要になってきます。

これはWeb制作においても、JavascriptやPHPのみならず、CSS(SCSS)やHTMLなどでも同じことが言えます。

メンテナンス性の高い制作をするためにも、リーダブルコードを身につけて(心掛けて)いきましょう。

著:Dustin Boswell, 著:Trevor Foucher, 解説:須藤 功平, 翻訳:角 征典
¥2,640 (2021/11/21 02:47時点 | Amazon調べ)