コードリーディング入門！先人たちに思いを馳せればプログラミングがもっと楽しくなる

PHP カンファレンス 新潟 2025 でLTに登壇させていただきました！
https://fortee.jp/phpconniigata-2025

「コードを読むのになんだか時間がかかってしまう」、「上から読むのが非効率な気はするけれど、どこから見ればいいかわからない…」
このLTでは、コードリーディングの基礎を学び、そのコードが生まれた経緯を想像することで、コードリーディングをもっと楽しくする方法をお伝えします。

プログラム修正のため・調査のためだけのコードリーディングから、歴史を紐解きレガシーコードの深淵をのぞく、一歩踏み込んだコードリーディングをしてみませんか？

レポ
https://tech.codmon.com/entry/2025/06/13/120655

Transcript

1. 2025年5月31日 さかうぇ (@sakawe_ee) コードリーディング入門！ 先人たちに思いを馳せれば プログラミングがもっと楽しくなる
2. 2 新潟県胎内市生まれ。.NET → TypeScript → PHP👈now 2024年3月 コドモン入社。以来、新潟市からフルリモート勤務。 請求系ドメイン担当チームで開発・運用保守に携わっている。 自己紹介 さかうぇ ひかる 経歴 もっぱら家のこと（新築プロジェクト進行中🏠） 最近の気になり @sakawe_ee
3. コードリーディングしてますか？
4. 4 コードリーディングしてますか？ ・上から読んでいる ・アタリをつけて読んでいる ・生成AIちゃんに読んでもらう …etc
5. 5 では、読んでみましょう！
6. 6 準備 ・目的をはっきりさせる ・IDEやエディタを用意する
7. 7 準備 ・目的をはっきりさせる ・IDEやエディタを用意する 例題 □ ざっくり全体の流れを捉える □ 朝なのに打刻種別が帰りになってしまう条件を調べる
8. 8 全体を捉える
9. 9 全体を捉える 　1. 主人公を探す 　2. 構造を捉える 　3. 目的に合わせて焦点を絞る
10. 10 コードリーディングの基本 1. 主人公を探す 　• 戻り値など、主人公っぽい変数を探す 　• 初期パーティー（入力パラメータ）を確認する 　• シンタックスハイライトなどを使う
11. 11 主人公っぽい変数を探す 戻り値 戻り値 例) $result, $ret
12. 12 主人公っぽい変数を探す 戻り値 戻り値 例) $result, $ret echo
13. 13 初期パーティーを確認する 入力パラメータ
14. 14 初期パーティーを確認する 入力パラメータ シンタックスハイライト で流れを確認
15. 15 コードリーディングの基本 2. 構造を捉える 　• 流れに着目する 　• ブロック単位で眺める 　• 発生するイベントを把握する
16. 16 ブロック単位で、流れを掴む 初期処理 if サーバ時間との 　 差分チェック if 種別切り分け if 入力チェック 打刻時刻特定 データ更新 打刻種別特定 if 特定施設対応 パラメータ組立て DB更新 if エラー処理 保護者の方への通知 AWS SQSに送信 if 種別 パラメータ組立て 終了処理
17. 17 大まかなイベントを把握する 初期処理 if サーバ時間との 　 差分チェック if 種別切り分け if 入力チェック 打刻時刻特定 データ更新 打刻種別特定 if 特定施設対応 パラメータ組立て DB更新 if エラー処理 保護者の方への通知 AWS SQSに送信 if 種別 パラメータ組立て 終了処理 初期処理 時刻決定 DB更新 通知送信 結果返却
18. 18 コードリーディングの基本 3. 目的に合わせて焦点を絞る 　• 関連するパラメータ、イベントに着目する 　• 必要な情報に絞って読む
19. 19 コードリーディングの基本 3. 目的に合わせて焦点を絞る 　• 関連するパラメータ、イベントに着目する 　• 必要な情報に絞って読む 例題 ✅ ざっくり全体の流れを捉える □ 朝なのに帰りの打刻になってしまう条件を調べる
20. 20 焦点を絞って読む 初期処理 if サーバ時間との 　 差分チェック if 種別切り分け if 入力チェック 打刻時刻特定 データ更新 打刻種別特定 if 特定施設対応 パラメータ組立て DB更新 if エラー処理 保護者の方への通知 AWS SQSに送信 if 種別 パラメータ組立て 終了処理 初期処理 時刻決定 DB更新 通知送信 結果返却
21. 21 焦点を絞って読む 初期処理 if サーバ時間との 　 差分チェック if 種別切り分け if 入力チェック 打刻時刻特定 データ更新 打刻種別特定 if 特定施設対応 パラメータ組立て DB更新 if エラー処理 保護者の方への通知 AWS SQSに送信 if 種別 パラメータ組立て 終了処理 DB更新
22. 22 焦点を絞って読む 初期処理 if サーバ時間との 　 差分チェック if 種別切り分け if 入力チェック 打刻時刻特定 データ更新 打刻種別特定 if 特定施設対応 パラメータ組立て DB更新 if エラー処理 保護者の方への通知 AWS SQSに送信 if 種別 パラメータ組立て 終了処理
23. 23 焦点を絞って読む それっぽい名前のメソッド
24. 24 焦点を絞って読む 辿ると 打刻種別を決める分岐処理 （しかもコメント付き） それっぽい名前のメソッド
25. もう一つコツがあります
26. 26 コードリーディングの基本 4. 役割を理解しようとする • 実装＝”何をしているか”の前に”何をしたいか”を読む • 自分だったらどう実装するか仮説を立てる 全体 ブロック メソッド 変数 変数 変数 ブロック 変数
27. 27 コードリーディングの基本 4. 役割を理解しようとする • 実装＝”何をしているか”の前に”何をしたいか”を読む • 自分だったらどう実装するか仮説を立てる ➡ 実装者の立場で考えるようになる
28. 28 コードリーディングの基本 4. 役割を理解しようとする • 実装＝”何をしているか”の前に”何をしたいか”を読む • 自分だったらどう実装するか仮説を立てる ➡ 実装者の立場で考え始める そして見えてくるもの…
29. 29 コードが書かれた背景が見えてくる • 過去の状況を推察したり • 仕様と実装の違いがわかる＝バグに気づいたり • 本来やりたかったことが見えてきたり
30. 辿ると 入退室種別を決める分岐処理 （しかもコメント付き） あれとかこれとか ありがたや！ なんで…？ 通らない分岐 がある
31. 辿ると 入退室種別を決める分岐処理 （しかもコメント付き） 通らない分岐 がある ありがたや！ なんで…？ 楽しい！！
32. 思いを馳せるコードリーディング 以上！
33. ブースあります