はじめに
つい最近インターンの子がコードを読んでいて
「なんで今ここみてるんだ...」
とつぶやいていました。
そういえば、新卒1年目の頃に私も同じようなこと経験して、メモとったなあと思い出し、
今回の記事を書いてみました。
知識のある人からしたらもっといい書き方あるだろうに...
って思う内容かもしれませんが、私はこれでコードを読む力をつけることができたので
コードを読んでいて迷子になってしまうことに悩んでいる人がいたらぜひ試してみてください！
当時のコードリーディングメモ
先にワンクッション入れさせてください。
一応一番見れるやつを選んだんですが、人に見られるなんて当時一切思ってなかったので、
マジで字汚いです...誤字もあります...ごめんなさい。
それではどうぞ！
....あまりにもメモ書きすぎるので補足させていただきます。
ざっくりですが、基本は、
- →: 処理の流れ
- □: Class
- ◯: メソッド
で！上記の中に、読んでいてわからなかったことや関数・処理・条件を書き込んでいます。
(途中わけわかんなくなって◯囲み連発してる....)
今でこそ、少し知識もついてきたので、もっとちゃんとしたフロー図書いた方がいいなー
とか色々思うのですが、当時はそんな知識一切ない状態なのでこれが精一杯でした。
ただ、こんなメモでも書き始めてから少しずつ書いてあるコードへの理解度が変わってきました。
全然この辺は言語化できてないのですが、
メモを取るにあたりやった行動自体も影響してるのでは？
と思っています。
具体的にはメモを取るときに↓のようなことをしていました。
- メモする時にコードに書いてあることをそのまま書かず、自分の言葉で書く
- 何度も処理の流れがわかるまで線をかきながら流れを覚える
- 複雑な条件は口に出しながら書く
ただコードを追うだけではなく、体でコードを叩き込んでたのがよかったのかもしれない(?)
最後に
だいぶフワッとした感じで終わっちゃいましたが、
私が新卒１年目に書いたコードリーディングノートのお話でした！
今コードが読めない助けてーって思ってる人。大丈夫。
当時こんなメモしか起こせなかった小娘は今、
しっかりフロー図もシーケンス図も書けるようになって、
立派(?)にエンジニアしてますよ。
諦めずに頑張ろう！！！
以上！