コードを読む時に意識していること - エニグモ開発者ブログ

こんにちは、サーバーサイドエンジニアの橋本です。

この記事は Enigmo Advent Calendar 2022 の 14 日目の記事です。

はじめに

エンジニアとして仕事をしているとコードを読むことが多いと思います。例えば、仕様調査、CSからのお問合せ対応、レビュー対応などがあると思います。
今年を振り返るとコードを書く以上に読むことが多く、コードをより正確かつ速く読むにはどうすればいいかを考えることが多くありました。ということで、この記事では私個人がコードを読む時に意識していることを紹介していこうと思います。

いきなりコードは読まない

1つ目はいきなりコードは読まないことです。業務で使われているコードの量は1つの機能でもとても多いです。いきなり読み始めるととても時間がかかったり、迷子になってしまうかもしれません。なのでまずはシステム全体を把握してインプットとアウトプットが何なのかの理解を進めます。把握の仕方は、システム仕様書を読んだり、担当した方とMTGして処理の大まかな流れを教えてもらっています。全体の把握と同時並行で、実際に動かしてみることが多いです。実際に動かすと理解が進みます。

読む目的を意識する

2つ目は読む目的を意識することです。コードを読む目的は様々だと思います。表は一例です。

コードを読むケース	知りたいこと
レビュー対応	バグが無いか、仕様を満たしているか、設計的に問題ないかを確認する。
CSからのお問合せ対応	バグが発生している原因を知る。

目的が曖昧な状態でコードを読み始めると、本来は読む必要が無いコードも読むことになり時間が足りなくなるケースがあると思います。業務は期限が決まっていることが多いので、効率的に進めるためにも目的を意識することは大事だと考えています。

適度にメモを取る

3つ目は適度にメモを取ることです。業務で使われているコードは量が多く、一度に読んで全てを把握するのは大変です。なので私はメモを取りながら読み進めることが多いです。メモの取り方ですが、ソースコード上に直接書いたり、別途テキストファイルに書いたり、slackのスレッドに書いたりなどして流れを整理しています。まだ慣れていないプログラミング言語の場合は読むのに時間がかかると思うので、メモはかなり有効だと感じています。