はじめに
まずはこのソースコードを見ていただきたいと思います。
いかがでしょうか。なんとなく二重ループをして何かを出力しているのかな?くらいは読み取れるものの、このソースコードが具体的にどのような値に対してループ処理を行い、その結果どのような出力を行うのか、パッと見では理解することが難しいソースコードだと思いませんでしたか。
それもそもはず、このソースコードは人間にとって理解するのに時間がかかるソースコードになってしまっているのです。
しかし現在のIT業界では、誰が読んでも理解のできるソースコードを書くことが求められています。プログラマーといて生きていくにはこの読みやすいソースコードを書く能力を身に付けることが必要不可欠と言っても過言ではありません。
そのために必要なこととして、なぜ読みやすいソースコードを書く必要があるのか、そして読みやすいソースコードを書く方法を2回にわたって解説していきたいと思います。
なぜ読みやすいソースコードを書く必要があるのか
読みやすいソースコードを書く必要性
そもそもとして、なぜ読みやすいソースコードを書く必要性があるのでしょうか。
一言で表すと、「ソースコードを理解するためにかかる時間の短縮のため」です。
例えば自主学習としてプログラミングを行う場合。復習のために過去のソースコードを見直す時もあるでしょう。
もしかしたらゲームなどを開発していて、以前作成した機能に変更を加えたいなんてことがあるかもしれません。このときあなたは何か月も前に書いた上記のようなソースコードを見直して、どんな機能のソースコードを書いたかすぐに理解できるでしょうか。きっとなんとなくしか覚えていなくてすぐには理解できず、多くの時間をかけて理解することになると思います。
他にも仕事でプログラミングを行う場合。チームでの作業になるでしょう。このときあなたが書いたソースコードが上記のようなソースコードだった場合、コードレビューをしてくれる人や今後機能の改修をしてくれる人などなど、多くの人が毎回ソースコードを理解するのに多くの時間を割いてから自分の作業を行うことになってしまいます。
これでは作業効率が悪く時間がもったいないです。
読みやすいソースコードを書く利点
先にも記載した通り、最大の利点は「ソースコードを理解するためにかかる時間の短縮のため」です。
毎回毎回ソースコードを読んでは「このソースコードはなんだろう?」なんて何十分も考えるのは、はっきり言って時間の無駄です。もし読みやすいソースコードが書いてあれば時間をかけずに、場合によっては一瞬でソースコードを理解することができます。
もう一つの利点として、これはどちらかというとプログラミング初心者向けではありますが、「自分がどんなソースコードを書いているか理解しながらプログラミングができる」という点です。
プログラミングができるようになってくると、楽しくてソースコードを書く手が止まらなくなることがきっとあります。そうして夢中になっているとふと気付くのです。「この変数って何が入っているんだっけ?」と。読みやすいソースコードになるよう意識してプログラミングをすればこのような事態はきっと防げます。
おわりに
今回はなぜ読みやすいソースコードを書く必要性があるのかについて解説してきました。
次回は読みやすいソースコードを書く方法について、「はじめに」に記載したソースコードを修正しながら解説していきたいと思います。
↓次回の記事はこちら↓