昨日、必要に迫られてJava製Webアプリのコードを読んでいました。
その際に気づいたことや、今後どうしていくべきかを考えたので記録しておきます！
課題1. どの行を読んでいたのか、忘れる
僕の場合ですが、集中していると、ちょっとした「ど忘れ」のようなことが発生してしまいます・・・。
ソースコードを読む時、関係するオブジェクトのメソッドが呼ばれて、別ファイルのソースを読むというのは、 頻繁にありますよね。
その際に、呼び出し先の別ファイルに移動し、メソッドの中身を追っていくと思うのですが、 ざっと処理と戻り値を確認した後、いざ元のソースコードに戻ろうとしたら・・・
「あれ、どこ読んでたんだっけ？」となってしまうのです！
時間をかければ、なんとか元の場所に戻ることができるのですが、 このちょっとした時間が「地味なストレス」や「理解を妨げる要因」になっているように感じてしまいました。
課題2. 処理するデータのイメージが湧かない
今回もそうだったのですが、ソースコードだけを見ても、どんな処理なのかわからないことがあります。 そのような状況に陥った場合、僕は図を描いて、理解を試みることにしています。 なお、理解できた後は、用紙を捨ててしまっているため、後で読み返すことができない状況にあります
今後どうしていくべきか
対策として、ツール「OneNote」を使うことにしました。
- プログラム言語ごとに、セクションを作成し、「目的」や「ソースコード」単位でページを作成する
- コードの行番号と該当処理、簡易メモを記述する
- データイメージが必要になった場合、図を挿入する
ソース見れば良いのではと思うかもしれないのですが、読んだ部分の記録を残す意味で、僕にとっては有用そうだと考えました。
- イメージとしてはこんな感じです（Javaのコードは載せられないので、Pythonにしました）
1つ問題としては、手書きメモがこのままでは描けないことですね。 別途、スタイラスペンを購入したらもっと良いかもしれませんね。
それでは。
