コードを読むタイミングはいくつかあるのですが、まずはどういう時にコードを読むのかを5つほど紹介します。

1.学習時

学習の時が、一番はじめにソースコードを読む機会が訪れます。

まずは学習したばかりの時、知識をつけるためにソースコードを読むと思います。

その次は新機能を学習する時です。Javaなどのプログラミング言語は定期的に新機能が追加されます。新しい機能を学習する時もプログラミングを読むことになります。

そして、人に指導する時です。教えている人がコーディングをした時にそのコードが正しいかどうかを確認する時にコードを読みます。

学習の時だけでもコードを読む機会がかなり多くなりますが、次からが実務でコードを読むタイミングになります。

2.プロジェクト参画時

既存のプロジェクトに参画する際には、どのようなコーディングをしているか確認する必要があります。

全てのソースコードが同じ形式で書かれている訳ではないため、コードを読み、どのようなクセをしているかを認識する必要があります。

また、Springや、Hibernateなど使用しているツールがどのような特性があるのかを知る必要もあります。

3.デバッグ、トラブルシューティング

コーディングした後にデバッグする際、エラーやトラブルが出てくることが頻繁にあると思います。

その際にどこでエラーが起きているか、またコードを読んでどの部分がエラーを出してる原因なのかを追及する必要があります。

4.新しい機能の理解

Javaがアップデートした際にはどの部分がアップデートされたのか、既存のコードがどのように書き換えられるのかを知る必要があります。

その際にはコードを読んで理解する必要がありますが、いままで説明したものに比べて頻度は低くなります。

5.コードレビュー

最後は、コードレビューについてです。

チームで開発する際にはコードレビューをすることがあります。他の人が書いたコードが正しいかどうかを判断する必要があります。

しっかりとコードを読むことができれば、コードの品質を高い状態で保つことができます。

続いて、コードを読むコツをいくつか紹介します。

ただ単にコードを最初から最後まで読んでいては時間がかかりすぎるため、無駄な時間を過ごすことになります。

以下で説明したコツを利用することで効率的にコードを読むことができます。ちなみにコードを読むことをコードリーディングといいます。

それではコツを説明していきます。

1.目的を明確にする

目的を明確にすると言われてもソースコードを読むことが目的ではないのかと言われるかもしれません。

ただコードを読むだけだとはじめに述べたように時間だけがかかるためです。

では目的を明確にするにはどうすれば良いかというと、なぜコードを読むことになったのかを理解することです。


前の章で述べた事が目的の例として挙げられます。

不具合を見つけるためなのか、もしくはレビューをするためなのかなどです。

学習するためだけであれば、コードを全部読んでも良いかもしれません。

このようになぜコードを読むのかを理解することが初めの段階としては重要な項目です。

2.読まなくても良い部分は読まない

こちらも、読む前に理解、認識しておかないといけない事になります。

目的を明確にした後はどこから読み始めれば良いかを確認しましょう。

例えば、エラーが発生した場合はどこでエラーが発生しているかが表示されると思います。

そのエラーメッセージを確認して、どのメソッドなのか、どのクラスなのかを特定して読み始めることで読まなくても良い場所を読まずに済みます。

そういった工夫をすることでソースコードを読むスピードが格段に上がります。

3.推測しながら読む

ソースコードを読む前に理解しておかないといけないことは以上になります。

続いて実際にコードを読む方法になります。


読まないといけない場所が分かっていてもその部分がシステムによってはかなり膨大な量になる事があります。

いくら読まないといけなくても膨大な量になってしまえば読む時間がかなりかかります。

その際に必要なコツとしては推測しながら読むという事です。簡単な例を確認してみましょう。

Test.Write("test.txt")

上記の例を見てみると、クラス名やメソッドの名前しか分かりませんがなんとなく「test.txt」というファイルを出力するのかなということくらいは分かると思います。

これが推測して読むということです。

そのためにはクラス名などが適切な命名になっていないといけないということもありますが今回は割愛します。

推測して読めるようになると、本当に重要な場所が分かるようになります。

4.無駄なソースコードは消して読む

既存のシステムの改修時は特に気を付ける部分になります。

長年改修してきたことで、不必要なコメントやコードが残ってる場合があります。


例えば戻り値チェック、エラーハンドリング処理、過去のコードや履歴を消したコメントが不要なコードの一例になります。

ただ、無駄なコードを消す場合は必要だった場合を考えないといけないので必ずプロジェクトリーダーや上司に許可を取ることが必要になります。

5.メモを取る

最後にメモをとるということです。

何千行もコードを読むと最初の方で読んだメソッドや変数を忘れてしまい、何度も同じ処理を読んでしまう場合が多くあります。そのため重要なメソッドや変数はメモをしておき、何度も読まないように気を付けることが必要になります。

コードリーディングができるようになると、いくつかメリットがあります。

下記に3つほど挙げてみます。

1.コーディングスキルの向上

コードを読めるようになると、コードを理解する能力が上がりコーディングスキルが向上します。

コードを複数読むと、悪いコードや良いコードを読むことになると思います。

そうすることで、自分の知識が増えることになるので実際にコーディングする際の引き出しが多くなります。

2.信頼性の向上

コードリーディングができるようになると、コードの品質向上に役立てることができます。

無駄に長々書かれているコードを適切な長さのコードに書き換えることで、処理を単純化でき、メンテナンスのしやすいコードを書くことができます。

また、ファイアウォールなどのコンフィグを読めれば、セキュリティの向上に役立てることもできます。

3.自己表現の向上

コードリーディングができるようになると、書かれたコードを理解できるということなのでどのようなコードが正しいコードだったり、悪いコードをどのように直すべきなのかコミュニケーションができるようになるので充実した打ち合わせや議論を交わすことができます。

上記で記した２つのメリットにも通づる能力を身につけることができます。