リーダブルコードで大切だなぁと思った部分

エンジニア1年生の僕はコードの正しい書き方がわからなかったので、
とりあえず、伝家の宝刀リーダブルコードを読んでみました。
大切だなぁと思った部分をまとめておきます。

リーダブルコードはぱっと見で読みやすいコードを書くための
Tips集というようなイメージでいます。

そのため本記事ではぱっと見のコードをわかりやすくするものをまとめました。

外観に関して

コードをパッと見たときに、カタマリになっていて、一貫性があることを意識したい。
コードを段落に分けることや、縦の列が綺麗になっていることはもちろん、
適宜、メソッドを用いたり、変数の並びに意味をもたせながら美しさを意識する。

変数名について

変数名は明確な動詞や名詞を用いて、具体的に定義するべきである。
単語を意識するだけでなく、大文字やアンダースコアに意味を持たせることで、
より分かりやすい変数名を付けることができる。

コメントについて

他人がコードを読んだときに、誤解されやすいかどうかを考えながらコメントを書くべきである。誰が見ても自明なものにコメントを付けるよりも、自分しかわからない仕様になっている部分に簡潔なコメントをつけることが大切だ。

コードの長さについて

ライブラリを利用するなどして、コードの長さを短くすることを心がける。
そのためには、ライブラリに目を通しておくことが必要だ。
また、式や関数を短くすることや、変数のスコープを小さくすることでも
短いコードを書けるようになる。

関数について

一つの関数には一つのタスクを割り当てる。
そうすることで、関数の名前付けがしやすいし、コードの独立性が保たれ、
より意味を持ったコードが書きやすくなる。

参考文献
リーダブルコード（Dustin Boswell,Trevor Foucher著、角征典訳、株式会社オライリージャパン版）