読者です 読者をやめる 読者になる 読者になる

気ままなタンス*プログラミングなどのノートブック

プログラミングやRPGツクール、DTM、VOCALOIDについてのんびり書きます。

【メモ】忘却しないための個人的なソースコードの追い方

メモ ソースコード

昨日、必要に迫られてJava製Webアプリのコードを読んでいた。

その際に気づいたことや、今後どうしていくべきかを記録しておく。

どの行を読んでいたのか、忘れる

僕の場合、集中していると、ちょっとした「ど忘れ」的なことが発生し得る。

あるファイルのコードを読んでいて、関係するオブジェクトのメソッドが呼ばれるパターンは当然ある。

別ファイルに移動し、メソッドの中身を追っていき、ざっとアウトプットを確認した後、いざ戻ろうとしたら・・・

「あれ、どこ読んでたんだっけ?」となる。

一応、早くて10秒、遅くとも1分程度で、元の場所を特定できているが、 このちょっとした時間が「地味なストレス」や「理解を妨げる要因」になっているように感じる。

処理するデータのイメージが湧かない

今回もそうだったが、ソースコードだけを見ても、どんな処理なのかわからないことがある。

(あまりにわからなすぎて、肺に穴が開くかと思ったが、時間をかけて、なんとか理解できた。なんか最近無茶ぶりが多いZE!)

そういう場合、不要になったA4用紙の裏面に、図を描いて、理解を試みている。 理解できた後は、用紙を捨ててしまっており、あとで振り返ることができないのが現状。

今後どうしていくべきか

  • OneNote使うことにした

    • プログラム言語ごとに、セクションを作成し、 「目的」や「ソースコード」単位でページを作成する。
    • コードの行番号と該当処理、簡易メモを記述していく
    • データイメージが必要になった場合、図を挿入
    • ソース見ればいいじゃんとも思うけど、読んだ部分の記録を残す意味で、自分にとっては有用そう。
  • こんな感じ。(Javaのコードは載せられないので、Pythonで。)

f:id:rinne_grid2_1:20151017081336p:plain