コードにどんなコメントを書くのかの充実っぷり！『リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック』（Dustin Boswell, Trevor Foucher）【本】

小檜山歩

10年前

プログラムを書くこと自体について考えるための本として手に取ったうちの1冊。1つ前に紹介した『プログラム書法』よりも少し新しい本。言語はFortran、PL/IからC++やJavaへと移り変わっている。

コードにどんなコメントを書くのかの充実っぷり！

まさに開発者としてコードを書いている時にこの本に出会い、一番参考になったのがどんなコメントを書くべきなのか。基本的に設計書に書かれている見出しや内容をコピーしているだけだった自分にとっては目からうろこ。

「コードからすぐにわかることをコメントに書かない」や「優れたコード＞ひどいコード＋優れたコメント」、全体像のコメントと要約コメントの違いなど、当たり前かもしれないけど、出来てない人が多いであろう内容。

読み物としては少し分厚いけど他の技術書よりは薄めで、困った状況を風刺漫画っぽく表現してくれるところも入門書としてオススメできるところ。美しいコードを書きたいなら読んでみてもいい。

なんでしょうか。答えは「何も書かれていないコード」。設計書があって、その通りに作れば開発者としてお金がもらえる時代は終わりつつあると感じる昨今だからこそ、余計に刺さった言葉。開発者から矛盾を指摘したり、更に好ましい処理の方法を提案していかないといけない。もちろん、工数の増えない範囲で。

【手に入れたきっかけ】

プログラミングについて勉強しようと思って購入した本のうちの1冊。

【オススメ度】

★★★★★

【キーワード】

読みやすいコードを書くのに面白いことをする必要はない

あるあるなマンガ

C++、Python、JavaScript、Java

コードは理解しやすくなければならない

名前に情報を。美しいコードを。

コメントすべきことは…？

・コードからすぐにわかることはコメントしない

・優れたコード＞ひどいコード＋優れたコメント

・欠陥へのコメント

・「全体像」・「要約」コメント

・なんでもいいから書く

ネストは浅く

最も読みやすいコードとは…？

テストしやすいようにコード設計

コンサルタント：日系総合コンサルティングファーム

渋谷のITベンチャー→日系人事コンサル。会社ではコンサルしながらCSRの活動もしてます。いろいろ無秩序につぶやきます。2017年5月から1年間タイでトレーニーとして働いてました。今は帰ってきて日本で働いてます。