suzuderu

他人のコードを読む順番を先に決める

サンプルや既存のプロジェクトを開くと、どこから読めばいいのか分からないまま上から眺めて終わります。書いた人の意図を追うには、読む順番を自分で決めておくほうが早く進みます。順番が決まっていれば、途中で迷っても戻れます。

入口を一つだけ決める

起動するファイル、最初に呼ばれる関数、画面なら最初に出るページ。どれか一つを入口と決めて、そこから外へ広げます。いきなりディレクトリ全体を眺めると、関係のない部分に時間を使います。入口が見つからないときは、設定ファイルや起動用のコマンドから逆に辿ります。

データの形から読む

処理より先に、扱っているデータの形を見ます。何が入っていて、どこから来て、どこへ行くのか。形が分かると、処理の意味が推測できるようになります。型や項目名が分かりにくい場合は、実際に入る値を一度出力して確かめます。

一往復だけ通して読む

入口から出口まで、細部を飛ばして一度通します。分からない関数は名前だけ見て先へ進みます。全体の流れが分かってから戻るほうが、理解が早くなります。

分からなかった場所を書き出す

飛ばした箇所を一覧にします。そのまま学習の材料になり、何度も同じところで詰まっていることにも気づけます。

テストがあれば先に読む

テストは、書いた人が何を守りたかったかを示します。仕様の説明より正確なことが多く、短時間で意図が掴めます。テストが無いプロジェクトなら、README の使い方の例が同じ役目を果たします。

動かして一か所だけ変える

読むだけで終わらせず、動かして一か所だけ変えます。壊れ方を見ると、どこがどこに効いているのかが分かります。変える前に戻せる点を作っておきます。

読んだ記録を短く残す

入口、データの流れ、分からなかった箇所。三つだけ書いておけば、次に開いたときに最初から読み直さずに済みます。学習の段取りや公開前に確認する項目の整理は AI Craft Campus でまとめています。