文系未経験ITエンジニア、コードリーディングのコツを調べる

プロジェクトに配属されました

まだ研修期間中ではありますが、プロジェクトチームに配属されました。

チームリーダーの方にサポートしてもらいながら、実践を通して学んでいきます。

初めて実際に使われているコードを見た

おお、、これが実際に使われているコードなのか…「多いな!!!」というのが第一印象。

でも、実際にそのプログラムでどのような処理を行っているのか聞いたあとは、「え、これだけのファイルでそんな色んな処理できるんか…!」という印象に変わりました。

初めての実装

先輩に手取り足取り教えてもらって、初めてコードの実装(めちゃ簡単なやつ)をやらせていただきました。

実際自分は打っただけ(というかコピペ)ですが、ちょっと感動しました。これが自分がこれからやっていく仕事なのか…!

コード読まなきゃ

今後の仕事のイメージが掴めたところで、やっぱりコードの全体像を最初に把握しないといけないことを実感。

でも、研修でコードリーディングってムズいな、、と思ったばかり。

じゃあ先人の知恵を借りよう!

一旦ネットで「コードリーディング」と調べる

ということで、ここから本題。

細かいコードは読まない方がいいらしい

牛尾さんって有名な方な気がする…!(詳しくはしらない)

こんな人でもコードの細かい部分は読まずに進めているのか。

note.com

まずは全体像を確認

いきなりファイル内を見るのは、「木を見て、森を見ず」。たしかに!

まずはドキュメントを読んで、どこでどんな処理が行われているのかをざっくり理解するところから始めるようにします…!

qiita.com

まとめ

とりあえず、以下の点に気をつけて読んでいきます。

  1. まずはコードの全体像を把握する
  2. その際に、ドキュメントを活用する
  3. 行われている処理の順を追ってみる(トリガーを見つけるのがムズいので、ここは分からなかったら先輩に聞く)