リーダブルコード の商品レビュー

ダスティンボズウェル,トレバーフォシェ【著】,角征典【訳】

2023/06/30

■他の人が最短時間で理解できるように書くこと
　・正しい記載にすること、行数を減らすことよりも、理解しやすいか

■名前に情報を埋め込む
　・より具体的な動詞を使う
　・単位も含める startTime_ms
　・属性も含める encoded_url

　　start -> lauch open begin create
　　make -> create setup build add new compose
　　find -> serch extract locate
　　send -> deliver announce

■イテレータ変数も工夫する
　members_i users_j など

■範囲の指定など
　・限界値を含める場合　min-max
　・範囲の指定　first-last
　・包含/排他的範囲には　begin-end

■美しさ
　・読み手が慣れ親しんでいるパターンと、一貫性のあるレイアウトで書く
　・似ているコードは似ているように見せる
　・関連するコードはまとめてブロックにする

■コメントの目的は、書き手の意図を読み手に伝えること
　・読み手が驚きそうなところは動作を文書化しておく
　・ファイルやクラスは全体像をまとめておく
　・細部にとらわれないように、コードブロック単位で処理の概要をコメント残す
　・処理自体の説明ではなく、どういう目的でどういう処理してるかを書く
　・これからやろうとすることを、簡単な言葉で説明する

■条件文の左辺・右辺
　左辺：調査対象の式、変化する
　右辺：比較対象の式、変化しない

　君が18歳以上なら　〇
　18年が君の年齢以下なら　×

■無関係な下位問題を抽出してメソッド化

2023/05/20

変数名やメソッド名の付け方、ロジックの組み方など、小さなことから大きいことまで様々な粒度でコーディング時に注意することが学べた。
読みやすいコードとは何か、ここまで明確に言語化されて、根拠を提示されて、具体例も添えられていて、とても親切で分かりやすかったです。
何度も読み返す必要がありそうです。

2023/05/15

初学者が読んで難しいところと読みやすいところが混ざっています。
全てを一度に理解しようとするなではなく一つでも理解してそれを実践していこうとする姿勢が大事なのかなと。
私が印象に残ったのは関数で条件を満たさない場合は直ぐなreturnしてしまった方が良いというところと、フラグで条件を長々と書くのではなくフラグを使わず条件を満たしたのであれば直ぐに実行してしまえるならしてしまった方が良いこと。

2023/05/03

エンジニアになったばかりの今読んで、理解できる部分と、まだ実感が湧かず理解できない部分がある。
この先成長した時にもう一度読み直したい。

非常に重要なことが詰まっている本だとは思った。

2023/04/16

これは間違いなく必読書！業務でコードを書く人はモチロン、個人での趣味開発でもコーディングのスキルをぐっと引き上げてくれる良書でス。難しいことができるようになる本ではないですガ、コードを書く上で大切なことは何かという事を教えてくれるのデ、プログラミングをちょっと始めてみテ、hello worldやチュートリアルの写経からもう一歩踏み出そうと言う時に読むのが個人的オススメ

2023/04/03

もっと早く読んでおけば良かった、と後悔。
後回しにしていた過去の自分に教えたい。
当たり前のことばかりだが、その当たり前を自分ができているか？と考えた時、ポロポロ取りこぼしがあった。
実践と再読の繰り返しが必要。

2023/04/03

コードを書く人の必読書だと聞き、読んでみた。
エンジニアリングとは、大きな問題を小さな問題に分割して、それぞれの解決策を組み立てることに他ならない。

自分天才！と思える短いコードを書くより、少し長くても初見の読み手が早く理解できる読みやすいコード、理解しやすいコードを書くことが大事。

以下、印象に残った内容

コードを書く際の基本
・他の人が最短時間で理解できるように書く

名前に情報を詰め込む
・GetPageではなくFetchPage、StopではなくResumeやPauseなど、処理がより明確になる単語を使って名前を付ける
ヒント:シソーラス(類語辞典)を使って単語を調べる

・イテレータが複数あるときには、インデックスに明確な名前を付ける
E.g.: i,j,kではなく、club_i,members_i,users_i

・変数名に単位を入れる
E.g.: start_ms

・危険や注意を喚起する情報を変数名に追加する
E.g.:暗号化前のパスワードならplaintext_password

・スコープが小さければ、変数名は短くて良い、スコープが大きければ、名前に十分な情報を詰め込んで明確にする

誤解されない名前
・限界値を含める時はlimitではなくmin,maxを使う
・範囲を指定する時はfirst,lastを使う
・包含/排他的範囲にはbegin,endを使う(beginは含め、endは含めないが基本)
・ブール値の変数名は、頭にis,has,can,shouldなどをつけて分かりやすくする

美しさ
・同じような処理をしているコードは、シルエットも同じようにする
・コードの列を整列する
・ある場所でA,B,Cの順に並んでいれば、別の場所でもA,B,Cの順にする

コメントすべきことを知る
・自分の考え、質問されそうなこと、処理の全体像、定数の値にまつわる背景などはコメントに記す
TODO:あとで手をつける
FIXME:既知の不具合があるコード
HACK:あまりキレイじゃない解決策
XXX:危険！大きな問題がある

制御フローを読みやすくする
・If/else条件は、否定形よりも肯定形を使う。単純な条件を先に書く。関心を引く条件や目立つ条件を先に書く

・do/whileループを避ける

・早めに関数から返して、ネストを削除する

巨大な式を分割する
・式を表す変数、説明変数を使う。式を説明不要でも、式を変数に代入すると便利
E.g.: username=line.split(':')[0].strip()

・ド・モルガンの法則を使い、notを分配して、and/orを反転する

2023/04/02

定番だし読まねばと思って4,5年経ってしまったけれど、ようやく読了。
一度は読んだ方がいい、というのも納得。
難しいテクニックは書かれていないし、言われてみれば当たり前のようなことばかりだけど、その当たり前が大事だよね…
「リーダーの作法」のコーディング版みたいな印象を受けました。

2023/03/02

プログラミング勉強中の方やプログラマー経験1-2年目の方は、是非一度読んだ方が良いと思います。プログラミングする上で意識した方が良いことが沢山書かれています。
内容もサラッとしているので読みやすく良い本だと思います。

2023/02/02

とても勉強になった。
変数の付け方の初歩的な話から、コメントの付け方等など模範解答のような決まった正解が無いものについて、概念的な説明ではあるが正解を教えてくれた。

初めて1年未満の自分としては、ちょっとコードに慣れてきて短く書くことが至上のように考えて、読みやすさを棚に置いていた節があり、この本を読んで反省した。

兎にも角にも、人に理解されるようなコード、理解しやすいコードを書く事を意識すれば良い。自己満なオナニーコードはダメと言うことが分かった！！