コードリーディングの進め方|入口・データの流れ・テストから既存コードを読む

コードリーディングは、既存のソースコードを読み、処理の動きや変更の影響を理解する作業です。大きなリポジトリを最初から最後まで読むより、答えたい疑問を一つ決め、その根拠となる経路を追うと進めやすくなります。

ここでは、新しい開発現場で既存コードを理解したい人に向け、静的な探索と実行による確認を組み合わせる手順を紹介します。

最初に読解の終了条件を決める

「このシステムを理解する」では、どこまで読めばよいかが曖昧です。「検索結果が0件になる条件を説明できる」「保存前にどの入力検査があるか分かる」と、確認する問いを具体化します。

公開されているコードリーディングの演習資料でも、疑問を出発点として起点を選び、制御フローとデータフローを追うモデルが示されています。コードリーディングのモデル

読む前に、対象の版、起動方法、依存サービス、テスト方法を確認してください。本番へ接続して調べることを前提にせず、利用を許可された検証環境を選びます。

利用場面から入口を探す

架空の検索APIで「空の検索語を送ると、なぜ結果が0件になるか」を調べるとします。入口候補は、APIのルーティング定義、画面の送信処理、検索条件を扱う関数です。

URL、画面の文言、エラーメッセージ、関連するテスト名など、実際に見える情報を手掛かりに検索します。ファイル名だけで処理を決め付けず、呼出元と設定を確かめます。

VS Codeでは、対応する言語の機能として定義、実装、参照へ移動できます。定義へ進む操作と、どこから使われているかを探す操作を使い分けると、往復しやすくなります。VS Code: Code Navigation

呼び出しと値の変化を並べる

例の経路が「受付 → 条件の正規化 → 検索 → 応答の整形」だと分かったら、各段階で値がどう変わるかをメモします。

箇所 入力 出力・分岐の確認
受付 空白だけの検索語 文字列として渡るか、入力不足になるか
正規化 空白を含む文字列 前後の空白を除くと空文字になるか
検索 正規化後の条件 空文字なら検索しない分岐があるか
応答 検索結果 空の配列をどう返すか

この表は架空のコードを読むための例です。関数名の意味から予想したことは「仮説」、実際の分岐やテストで確かめたことは「確認済み」と分けます。

外部ライブラリへ入ったときは、今回必要な入力・出力の契約を先に確認します。疑問に関係しない内部実装まで読み続ける必要はありません。

テストとデバッガで仮説を確かめる

関連する既存テストを読み、同じ入力があるかを探します。テストが外部検索をモックに置き換えているなら、そのテストだけでは実際の検索先の動作まで確認したことにはなりません。

安全な検証環境で実行できる場合は、境界にブレークポイントを置き、入力値や分岐を確認します。VS Codeの例では、Step Overは関数内へ入らず行を進め、Step Intoは呼出先の内部へ進み、Step Outは現在の関数を終えて呼出元へ戻ります。VS Code: Debugging

すべての行を細かく追うより、値が予想と変わった境界を絞ると効率的です。非同期処理や設定による切り替えがある場合は、読んだ経路が実際に選ばれているかも確かめてください。

読んだ結果を再利用できる形にする

最後に、問いへの回答、根拠となるファイルと関数、確認した入力、残る未確認事項を短く残します。「空白除去後に空文字となり、検索を省く分岐を通る」のように、条件と結果を結び付けます。

読んだだけで設計意図まで推測して確定させないことも大切です。意図が必要なら、設計文書や変更履歴を確認し、それでも不明なら質問を具体化します。

新しいチームへの参加全体については、エンジニアのオンボーディングも参考になります。小さな疑問を説明できるようになることを積み重ね、理解の範囲を広げていきます。

記事一覧へ戻る

ITの困りごとを、
まずはご相談ください。

何から手をつけるか決まっていない段階でも構いません。ご相談内容に応じて、担当者からご連絡します。

まずは相談する

採用へのご応募は採用エントリーからお願いします。