【初心者向け】読みやすいソースコードを書こう~解説編~

スポンサーリンク

はじめに

前回はなぜ読みやすいソースコードを書く必要性があるのかについて解説してきました。
今回はどのようにソースコードを修正すれば読みやすいソースコードになるかを解説していきたいと思います。

↓前回の記事はこちら↓

ソースコードを読み解く

まずは前回にも掲載した読みにくいソースコードを再確認していただきたいと思います。

やはり何度見ても読みにくいですね。
このようなソースコードですが正常に実行することができます。実行結果を見てみましょう。

 1  2  3  4  5  6  7  8  9
2 4 6 8 10 12 14 16 18
3 6 9 12 15 18 21 24 27
4 8 12 16 20 24 28 32 36
5 10 15 20 25 30 35 40 45
6 12 18 24 30 36 42 48 54
7 14 21 28 35 42 49 56 63
8 16 24 32 40 48 56 64 72
9 18 27 36 45 54 63 72 81

キレイな九九の表ですね。
まずはなぜこのような出力になるのか、簡単にですが処理を確認していきます。

1~2行目
calculationという名前の関数です。九九の計算結果を二次元配列で返します。

3~7行目
showという名前の関数です。二次元配列の九九を空白埋め2桁にフォーマットして出力します。

8~9行目
変数宣言です。九九の縦と横の値を宣言しています。

10行目
関数を呼び出しています。

解説があってもなかなか難しいですね。
しかしこのようなソースコードでも、パッと見で九九の表を出力するソースコードがわかるように修正することができます。

キーワードは「行間」「名前」「コメント」の3つです。
1つずつ順番に解説してきます。

スポンサーリンク

行間をあけよう

このソースコードの問題点として行間があいていないことが挙げられます。
行間があいていない場合、変数宣言や関数の分かれ目がわかりにくくなります。
変数宣言や関数などグループ分けをしたうえで行間があけることで、より読みやすいソースコードになります。

今回のソースコードは、1~2、3~7、8~9、10行目の4グループに処理が分かれているので、その間に改行をいれてみます。結果は以下の通りになります。

いかがでしょうか。改行を入れるだけでどこからどこまでが1つのグループかわかりやすくなりました。
しかしこれだけではまだわかりにくいですね。次は「名前」について解説します。

意味のある名前を付けよう

ここでの名前とは、「変数名」と「関数名」の2つの事を指します。
今回のソースコードは変数名に「a」や「b」といったアルファベット1文字の名前がついています。これでは例えば「a」という変数にどのような値が設定されているかソースコードを読み解かなければ判別することが難しいです。
同様に関数名についても、計算という意味の「calculation」という英単語が使われていますが、この関数がどのような計算をするのかはソースコードを読み解き判別する必要があります。

このような事態を防ぐためには、意味のある名前をつけることが重要になります。
例えば「a」という変数ですが、ソースコードを読み解くと九九の表の列の最大値を設定していることがわかります。そのため列という意味の英単語である「column」といった名前を付けてあげるとわかりやすくなります。
同様に関数「calculation」も、九九の計算結果を二次元配列で返す処理を行っていることから、「create_multiplication_table」といった名前を付けるとどのような計算をしているかわかりやすくなります。

一例として以下のようソースコードを修正しました。

いかがでしょうか。変数と関数を意味のある名前にすることで、それぞれの役割が明確になりソースコードがよりわかりやすくなったと思います。
さらに2~5行目は元々の2行目の部分なのですが、変数名を修正したことで1行の文字数が長くなったので、改行することでより見やすくしています。

スポンサーリンク

コメントを書こう

コメントを書くことでソースコードの処理内容だけでなく、コードを書いた人の考えを残しておくことができるため、非常に重要です。例えばどんなにステップ数(ソースコードの行数)が多い関数があったとしても、コメントを読むことでその全体像を読み取ることができるため、ソースコードを理解するための時間を減らせます。

今回のソースコードは行数が少ないということもあり、コメントはファイル全体、関数、定数に書いてみたいと思います。

いかがでしょうか。コメントを書いたことにより、ソースコード全体の内容がより分かりやすくなったのが理解していただけると思います。
ここまでくるとパッと見で九九の表を出力するソースコードがわかるようになり、いつ何時このソースコードを見返しても安心ですね。

おわりに

今回はどのようにソースコードを修正すれば読みやすいソースコードになるかをソースコードを修正しながら解説しました。
初心者向けということで基礎的な部分のみの解説でしたが、少しでもみなさんのコーディング技術向上につながれば幸いです。

スポンサーリンク