リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック

IT

おそらく数年エンジニアをやっている人で

聞いたことがない

見たことがない

なんてことは絶対にないこの本の紹介です。

スポンサーリンク

これを読まずにエンジニアは名乗れない?

面白いと、読みやすいは、違うんだよ?
こんな前書きで始まるリーダブルコード。タイトル通り「読みやすいコード」をテーマとした名著です。読みやすさと面白いは全くの別物。面白いことをする必要はなく、ただ『良い名前』、『適切なコメント』、『意味ある単位に分ける』といった綺麗で洗練されたコードを書くために必要なことを学びました。

プログラミング言語の学術書は多いけど、こういった暗黙知の部分に関する名著は少ない。
そういったいいでも本当に素晴らしい名著だと思います。

理解しやすいコードとは?

一文で表すならば以下でしょう。

コードは他の人が最短時間で理解できるように書く。

そのために行う3つのステップ。

1.実際にやる

実際に読みやすいコードを書いてみること。

難しく、賢いようなコードはなにより読みづらい。

2.それを当たり前にする

読みやすいコードを書くのが当たり前になるなるようにする。

デフォルトで読みやすいコードを書くようにする。

頭でっかちな賢いふりしたコードほど読みづらいものはない。

賢くなくて良い。見やすく、洗練された、シンプルなコードがなによりも美しい。

3.コードで伝える

文字通り「読みやすいコードを書いて伝えること」。

読みやすいコードとはどんなものなのかを、実際のコードで伝える。

その他大切なこと

名前に情報を詰めること

・明確な単語を選ぶ
・汎用的な名前は避ける
・具体的な名前を使用するようにする
・必要な情報(単語)を追加する
・名前の長さを決める
・名前のフォーマットで情報を決める

明確な単語や(※意外と難しいよね)

誤解を生まない名前

・名前が他の意味に捉えられることはないか考えよう。

コードに美しさは必要

※ここで言う「美しさ」とはレイアウトのことです。整ったレイアウトは可読性を高めます。

・読み手が慣れているパターンのレイアウトで書く
・似ているコードは似ているように書く
・関連するコードはまとめてブロックにする

コメントするべきこと

・コメントの目的は、書き手の意図を読み手に知らせることである

コメントは正確で簡潔に

・コメントは簡潔で情報を多く含むように書かなければならない

合わせて読みたい名著

スポンサーリンク
もしよければフォローして下さい!
大変励みになります。
IT
シェアする
スポンサーリンク
ベーシックインカム セミリタイアたまご