😃

【初心者】ソースコードリーディングのコツ(備忘録)

2023/01/07に公開

1.はじめに

・他人が書いたソースコードを読むコツについて説明しています。
・実務から得た経験を基にした記事になります。

2.ソースコードの読み進め方

①.先ずはアプリなどを動かして、どのような機能が備わっているのか確認します。
  確認できた内容をメモに残すと、コードを読み進める際の助けになります。
 
②.確認できた機能に関係のあるコードを見比べていきます。
  デベロッパーツールを活用しながら、コードを把握します。
  最初は大きくソースコード(どのような関数があるのか等)を把握します。
  分かったことについての記録(キャプチャも使用)も残していきます。
  コードリーディングが苦手な方にはおススメです。。。!

③.大きくソースコードを把握できたら、深くソースコードを読んでいきます。
  どういう処理が行われているのか把握することが大事です。
  全てのソースコードの意味を理解する必要はありません!

3.デベロッパーツールの扱いに慣れる

このサイトがおススメです

4.具体的な機能で説明すると...

①.先ずはアプリを動かし、機能を把握します。
 ・ボタンをクリックし、画面上の線にカーソルを合わせるとその線の色が青色に変化。
 ・青色に変化した線をクリックすると赤色に変化。
 以上の機能を確認できました。

②.機能毎に、大きくコードを把握します。(ここからデベロッパーツールを活用します)
  ・ボタンのクリック機能を司る関数
  ・カーソルを合わせた線が青色に変化する機能を司る関数
  ・青色に変化した線をクリックすると赤色に変化する機能を司る関数
  以上の関数が存在することが確認できました。

③.コードの大まかな把握が終わったら、各関数の記述を細かく追っていきます。
   関数内でどういう処理が行われているかを把握することが大事です。
   処理内容を把握するのが難しいと感じた場合の対応は以下がおススメです。
   1 先ず、コーディングされた文法や定数の値等を把握
   2 1で把握した内容から、処理内容を導き出していく

5.作業時間の見積もり(備考)

担当者から「どれくらいで終わりそうか」と質問される場合もあるかと思います。
その際、(焦りや不安から)急いで返事することは絶対にしないでください。
対処の具体例を示します。

①.「先ず担当範囲の〇×をやってみます。終わったら、確認頂けないでしょうか?」と質問します。
  承諾されたら、作業を進めていきます。

②.担当範囲〇×が終わったら、担当者に確認依頼を出します。
  確認が完了したら、作業予定時間を出して担当者に報告します。
  作業予定時間はこのように算出します。
  作業予定時間 = 作業〇×を始めてから確認が完了する迄に要した時間 × 担当業務数

③.予定時間より遅れそうであれば、なるべく速やかに報告しましょう。
  「予定通りに作業が進むことは基本的にない」と考えておくと良いです。。。!

Discussion