開発の現場では、動くプログラムを書いたら終わりではありません。
プロジェクトの人数等にもよりますが、基本的にプログラムを他人に見てもらうレビューという作業工程があります。プロの現場でも人にプログラムを一度見てもらってから実際に書いたプログラムを使用していきます。
ここでは、なぜ、人に見てもらう必要があるのか解説していきたいと思います。
レビューとは
前述では、プログラムは人に見てもらう必要があると記しました。
プログラムは、コンピュータに対する言葉です。ですが、プログラムを読むのはコンピュータだけではありません。
開発というのは複数人で行うことが殆どです。そうなると自分が別の作業で手が離せないときやプロジェクトから離れた後は、別の人が担当することになります。
書いたコードを修正したり手を加えたりするのは、自分だけではないのです。
そうなった時の為に他人に解りやすくプログラムが書いてあるか、良くない書き方をしていないか等を第三者目線で見てもらう為にレビューが存在します。
レビューで確認すること・されること
私も開発でレビューすることもありますし、されることもあります。
その時にどのようなことを意識して確認しているか挙げていきます。
- 規約に沿った記述がされているか（特にインデント）
- クラス名、関数名、変数名がわかりやすいか
- コメントなども含めて何をしているのか解りやすいか
- 無駄な処理をしていないか
- 繰り返しでDBにアクセスしていないか
「インデント」が無いプログラムは読みにくいです。いくら他が良くても読みにくいプログラムは使えません。レビュー依頼されたプログラムのインデントが崩れている場合は、それだけで再提出になる可能性が高いです。
クラス名、関数名、変数名に関してもよく見ています。 変数名や関数名等は主語や動詞のような物なのでこれができていればプログラムがわかりやすくなります。
他も解説したいところですが、長くなってしまうので別の記事で解説します。
プログラム学習者でも人にレビューしてもらう方法
プログラム学習時にもプログラムは見てもらった方が成長が断然早くなりますが、身近に経験者がいないとみてもらう機会が少なくなってしまいます。そんな時には以下の方法があります。
- GitHub等で公開する
- 他の初学者を募りプログラムを見せあう
- プログラミングスクールに通う
- 経験者にレビューをしてもらうサービスを利用する
GitHub等にアップロードすることで自分のプログラムを世界中に発信することができます。ですが、見てもらえる確率が低かったり、実際に使用するプログラムは公開したくない場合があります。
初学者通しで見せ合うことも可能です。Twitter等のSNSで「#プログラミング初学者と繋がりたい」等のタグをつけることで簡単にプログラミング仲間を探すことができます。これを利用することで他者とレビューしあうことができるかもしれません。しかし、この方法にはデメリットがあり、見るのが初心者同士なので時には間違ったことを言われることもあるかもしれません。
プログラミングスクールは、お金はかかりますが的確なアドバイスは貰いやすいです。特にレビューを目的とするならば、一方的に講義をされるスクールではなく、講師と相談しあえるスクールを探すのが良いかと思います。
そして最後にプログラムのレビューに特化したWebサービスも存在します。Webサービスを利用することで通う必要がなくオンラインでコードを提出することでプログラムに対してレビューをもらうことが可能です。
実は上記のサービスは、snomeと同じチームが運営しているサービスで、問題を解いて提出するたびに現役エンジニアがレビューを行いソースコードに対してコメントされます。
自動で採点する機能はありませんが、仕事で通用するソースコードの書き方をオンラインで教わることが可能です。開始したばかりのサービスですが、エンジニアの近道になるはずなのでよろしくお願いします。
まとめ
エンジニアはただ動くだけのプログラムが書ければよいわけではありません。出来る限り他人が読んでも分かるようなソースコードにしなければなりません。自分だけで作業していたとしても数ヵ月前のプログラムは何を書いたか忘れます。常に人に見られることを意識してソースコードを書いてみてください。