既存のプログラムコードを読むときは自分用の設計書を作る感じで

いまシステム改修プロジェクトのメンバーとして働いていて、ソースコードを読んで理解してほしいと言われています。

問題点の気づき

素直に言われるがままコードを追っていくのですけど、ひとつの課題について分かったと思ったら別の疑問が出てきます。

それを追いかけていると最初に追いかけていた課題でわかったことを忘れているということがありました。

自分用の設計書を作ろう

そういうことをなくすために、ソースコードを追っていくときに、話を聞くときと同じでメモを取った方が良いと思いました。

なんなら簡単な設計書を作るつもりでメモしたら良いという気づいてみたら当たり前の結論に至りました。

簡単な設計書の内訳

簡単なというのはリアル設計書のように詳しく書く必要はなくて、このモジュールからこの関数を呼んでなどを考えます。

このメソッドはこんな意味でみたいなことでそれも読んで「???」となった部分だけで良いと思います。

改善してみた結果

意識してできた日はとてもいい感じに仕事を進められたので、あとはしばらく経ってまた同じ状態に戻らないように習慣化する必要はありそうです。

習慣化するためのコツもあるようなないような気がしますが、続けやすいことで続けてよかったという実感が得られることだったら、習慣化もしやすいでしょうね。

Youtubeで「ソースコード解析」

コメントする

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

日本語が含まれない投稿は無視されますのでご注意ください。(スパム対策)

上部へスクロール