43
保守性
イーグルソンの法則
コードの記憶の減衰。
条文
もし
「半年見ていない自分のコードは、他人が書いたも同然である。」コードそのものより遥かに速く、頭の中のメンタルモデルは蒸発する。文脈はソースには保存されない。
ならば
「半年後に他人と化す自分のために、コードとコミットメッセージを書け。コードから自明でない判断は、その「なぜ」をコメントか ADR に残せ——頭の中だけに留めるな。」
ただし
ADR / 自己説明的なコード / 「なぜ」を記すコメント
出典
Peter Eagleson に帰される、プログラミングの口伝。カタログ化された「ソフトウェア開発の法則」群の一つとして長く流布。
原典へ関連する条文