ソースコードの読み方
改修のために長いソースコードを読む際に疲れ果てる事が多いので対処法を調べた。
(手順)
1.ソースを読む目的を明確にする
仕様書を読んでどの機能を実装する必要があるのかを知る。
他に確認しておいたほうが良い項目
・ディレクトリ / ファイル構成
・データ構造
2.動的に解析する
実際の動作を確認する。その際デバッガを用いて引数などにも着目する。
3.静的に解析する
目的に沿って必要な部分のコードだけを読む。余計なところを読まない。
上から順に読んだり、全てを理解する必要はない。
コツ
・いきなり関数の中身を読むのではなく、まず関数同士の呼び出し関係(コールグラフ)を把握する。
・関数を読む際に後で分からなくなりそうなら平易な表現に置き換えておく(元のコードはバックアップしておく)
・元の設計書とは別に絵、図、表などを用いて分かりやすく自分用にメモを作るのも良い
・(機能の)全体→細部と見ていく
なお、基本的な文法を知らないと分からない事が出てくるたびに調べることになって効率が悪いので、言語の仕様は一通り把握しておく。
コードが読めない際は要件を把握できていないのか、文法を知らず何をしているのか分からないのか、という風に問題を分割して考える。