プログラミング初学者向け 今日からできる きれいで分かりやすいコードを書くコツ4つ

コードは人が読むためのものです。

そのため、人にとって分かりやすいものである必要があります。

分かりやすいためには以下の二つを両立する必要があります。

  • シンプル
  • 十分な情報が含まれている

今日から実践できる4つです。

シンプル

一つの関数・メソッドは画面に収まるくらいの長さにする

コードを読むときにスクロールしていったりきたりすると、労力を消費します。

できる限り、関数・メソッドは画面に収まる行数にします。

もし、スクロールが発生してしまう場合には、さらに関数を分割することを検討します。

一つの関数・メソッドは一つのことを行う

ある関数・メソッドが複数の処理を行うことはあまり良くありません。

そのような関数を書いてしまうと、次に変更・追加するときもその関数に処理を追加する確率が高くなります。

その繰り返しによって、お化けのような関数ができてしまいます。

お化けのような関数はいくもの引数をもち、いくつもの分岐を処理内に持つようになるでしょう。

そして、関数名もかなり漠然としたものになってしまいます。

十分な情報を含める

変数名を適切に

a や b のような、それがどのようなデータか分からないような変数名をつけるのはやめましょう。

代わりに、user や id のような具体的な名前をつけます。

また、単数形か複数形かも意識しましょう。

例えば、複数のユーザーなら、user ではなく users とするべきです。

if文の条件部分は変数や関数にする

条件部分は、特にシステムの仕様の影響を受けるコードが書かれるため、仕様を把握していないとその意図を理解することができないことが多くあります。

例えば以下のコードは仕様を理解していないと分かりません。

if (price >= 2400) {
  //do something
}

これを以下のように置き換えることで、理解できるようになります。

const isGivedPoint = price >= 2400
if (isGivedPoint) {
  // do something
}