山傘のプログラミング勉強日記

プログラミングに関する日記とどうでもよい雑記からなるブログです。

リーダブルコードを読む その1

リーダブルコード

読みやすく理解しやすいコードを記述するための考え方を学びたかったので、プログラム系の技術書として有名なリーダブルコードを読みたいと思います。僕が見ているブログでも取り上げられていたのも読もうと思った理由です。

yjkym.hatenablog.com

 

 

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

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

 

 1章

同じ処理を行うプログラムでも短いコードが長いコードより優れているということではなく、冗長な記述となっても理解しやすいコードを作るべきである。つまり、他人が最短時間で理解できるコードを書きなさいということ。

コードの理解しやすさというのは、コードの効率化(コードの短さ?)やテストのしやすさといった指標とは競合しない。つまり、理解しやすいコードを書くことがコードの効率化といったことに結び付く。

 

2章

変数名や関数名に意味を持たせて重要な情報を追加するということ。

itやtmpなどの汎用的な名前は変数を一時的に使うときに限り使用できる。その他の場合では適切な名前をつけるべき。

for文の中のイテレータは混乱を避けるために、配列の名前の最初の文字を利用したり、明確な名前を使うことが望ましい。

変数が単位を持つ場合、単位を追加して変数を記述すると良い。例として、weightをweight_kgとしたりすることが考えられる。

長すぎる名前は良くない。むだにコードが長くなり、画面を大きく占有する原因となる。

変数が使われるスコープが小さければ短い名前でもよい。これは、コード見たときに、変数の使われ方がすぐにわかるため。

名前のフォーマットを考えて変数を記述する。エンティティごとに異なるフォーマットにすると、シンタックスハイライトの効果が得られる。_や-を適切に使うことで読みやすいコードになる。

 

3章

変数や引数や関数に誤解されない名前付けを行う。

英単語の語彙を増やし適切な単語を選ぶために類語辞典を活用することも必要。