FIELD NOTES FOR SYSTEM MAINTAINERS

保守運用ノート

動いて当たり前のシステムを、ひとりで守る人のための実務メディア

無料ツール|印刷用チェックリスト

長い関数・巨大ファイルの読み方チェックリスト

  • 何を知りたくて読むのかを、1行で書いたか
  • 目的に関係ないブロックは「今日は読まない」と決めたか
  • 関数の入口(引数・グローバル変数・最初に読むデータ)を書き出したか
  • 大きな分岐とループの位置を、行番号で拾ったか
  • 出口(return・DB保存・画面出力・メール送信・例外)を書き出したか
  • 追いかける値を1つに決め、出てくる行をすべて拾ったか
  • 値が「変わる」行と、それを囲む条件を確認したか
  • 別の変数や関数に渡ったあとも、名前を変えて追いかけたか
  • 分かったこと・未確認のことを、日付と行番号つきでメモしたか
  • 経緯の推測は、git blame などで確かめてから書いたか
  • 読んだ内容を、検証環境で動かして確かめたか
  • AIの要約を使った場合、実際の行で裏取りしたか
  • 読んだその日に、テストなしで分割・書き直しを始めていないか

全部できていなくても大丈夫です。「目的を1行」「値を1つだけ追う」の2つがあれば、長いコードで迷子になることはかなり減ります。

この内容は記事「長い関数・巨大ファイルの読み方|一人保守で迷子にならない順番」のチェックリストです。印刷してそのままお使いいただけます。 / 無料ツール一覧へ