歩き出しエンジニアブログ

「これがあってる」ではなく、「こう思ったよ」の技術日記的なもの。

リーダブルコード

リーダブルコードを読みました。

books.rakuten.co.jp

 

実践しようと思ったこと

誰かが読む前提で、コードを書くこと。

適当な変数名は避けて、長くなってもいいので、情報を盛り込んだ変数名をつける。

短縮系は避ける。

レビューを受けて読みにくいか、認識の齟齬がないか確認する。

言語自体の慣習も学ぶ。

英単語を学び、違う意味で捉えられることはないか、考えるようにする。

改行やTabを統一する。縦は絶対に揃える。

関連するものは、近くに書く。

考えていたことや情報の詳細をコメントに残す。できるだけ、簡潔に書く。

あまり複雑そうになるのであれば、コード自体が分かりにくい可能性があるので、リファクタリングする。

(間違っても、関数の名前を説明するようなものや処理をそのまま伝えるようなものは書かない。)

ネストは浅く。{{{}}}とか最悪。

余分な変数は使わない。代入してすぐ代入するならいらない。

同じコードを書くなら、汎用化する。

コードを簡単な言葉で説明してみると、コードがわかりやすくなりそう。