2
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 3 years have passed since last update.

コードリーディングのコツ

Last updated at Posted at 2020-10-22

・ソースコードを読む上での心構え👨‍🏫
 ー自分にとって必要な部分に集中して読むようにする。
  (完璧にすべてを細かく読もうとはしない。必要に迫られたら、そのときに読めばいい)
 ーそのソースコード(ファイル)の役割はなにか。
 (なんのためのソースコードなのか。扱うデータ(構造)と処理フローを意識する)

・ゴール(何をしたいのか)を明確にする(例. 注文取込の実装を理解したい)🏁
 ー何が実現できればいいのかをしっかり確認しておく

・ドキュメント(仕様書・設計書など)を読む📗

・目的になっている箇所(ファイル)を読む👀
 ーざっくり全体の構造や、どういう分類分けをしているかを把握する
  この時分からない英単語は、リストアップして調べておく

・ソースコードを読む手順📚
 動的にソースコードを追う(byebugなどを仕込んで、実際に入っている値を確認しながら理解していく)
 → 静的にソースコードを追う
   →この時メモを取る(クラス関係図やコードの行番号と該当処理など
              自分が必要だと思ったことについて簡潔にメモを取っていくようにする)
    理由
      作業が中断したときに内容をすぐ思い出せるようにするため
      休日などを挟んで、後日続きをやる時に忘れないようにするため

・関数や変数の名前から意味を推測する🤔
 ー関数名や変数名は、何を意味しているのかが明確にわかるようにつけられている
  例. function convert_int_to_string(number)などを見れば、
  int型からstr型に変換をする関数かな?と予想することが出来ます。

・if文やfor文のスコープ(範囲)に気をつける❗️
  if文やfor文など入れ子構造を持つものは、どこからどこまでがスコープとなっているのか
  見落としがちなので、「○○行目のforが何行目から何行目まで続いているのか」といったことをメモする

2
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
2
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?