人間が保守することを想定してコードを書く
Write code like a human will maintain it (unstack.io)
要約
LLM(大規模言語モデル)の普及により、開発者はコードの保守性を犠牲にしがちですが、AIは既存のコードベースから学習するため、悪いパターンを再帰的に強化してしまいます。著者は、AIを利用する場合でも、人間が保守しやすいコードを書くことの重要性を説き、将来的なコードの品質維持のために、AIに悪い習慣を学習させないよう注意を促しています。
全文翻訳
人間が保守することを想定してコードを書く
LLM(大規模言語モデル)の最も素晴らしい点の一つは、一日中コードを書いてくれることです。DRY(Don't Repeat Yourself)原則なんて誰が気にしますか? 同じ長い条件分岐を4つの異なるファイルで更新する必要はありません。AIがやってくれるはずですよね?
最近、AIを使って構築していたプロジェクトで、自分がそれに甘んじていることに気づきました。いくつかの場所で同じアクセスチェックが必要でした。ルートハンドラ、バックグラウンドジョブ、APIエンドポイント、Webhookなどです。そのたびに、必要なことを説明し、モデルが機能するものを生成し、それをマージしました。
各バージョンは、大体以下のようでした。
if (user.isActive && user.hasPermission('read') &&
!user.isSuspended && account.status === 'open') {
// do a thing
}
基本的に毎回同じ条件分岐です。4つの条件、おそらく変数名が少し違うだけで、単語を一つ二つ変えたコピー&ペーストのロジックです。これにはもっとクリーンな方法があります。例えば、自分で書くなら抽出するであろう共有ヘルパー関数などです。しかし、私はそうしませんでした。コードは動いたのです! テストはパスし、後でそれに触れるのは自分ではないのですから。
ここにあるのは怠惰です。ベストプラクティスに従っていない場合や、保守が面倒になることがわかっているコードの場合、それは何の違いになるでしょうか? 後で何かを変更する必要があるとき、LLMがそれを処理してくれるのであって、私ではありません。
ただし、LLMは真空の中で書いているわけではありません。それはあなたのコードベースを読み込みます。開いているファイル、既存のパターン、最近の変更などを参照します。あなたがコードベースにマージするすべてのショートカットは、ここでのやり方についてのシグナルとなります。次に同じアクセスルールを持つ別のエンドポイントをLLMに依頼したとき、モデルはゼロから始めるわけではありません。リポジトリにすでに存在する他の4つのコピーから始めます。
そのため、5番目のエンドポイントを要求すると、5番目の条件分岐が得られ、同じコピーされたコードが生成されます。リファクタリングを依頼すると、モデルはそれら5つすべてを維持します。なぜなら、それがあなたのコードの外観だからです。悪いパターンはもはや一度きりのものではなく、あなたのスタイルと見なされます。
このままにしておくと、後で修正しようとしたときにLLMがすべてのインスタンスをキャッチできると本当に信頼できますか?
確かに、これらのうちいくつかは壊滅的ではありません。物事はいつもこうして始まりますが、コードの「臭い」は積み重なります。重複した条件分岐、巨大な関数、「後でクリーンアップしよう」というマージはすべて、次のプロンプトに対するシグナルのレイヤーを追加します。最終的には、簡単にプロンプトで抜け出すことができなくなります。少なくとも、手を汚して袖をまくり上げることなしには不可能です。
最もフラストレーションがたまる部分:LLMに保守をアウトソースしていると思っていましたが、私が陥った滑りやすい坂道は、実際にはLLMにますます悪化する習慣をトレーニングしていたのです。
人間が保守することを想定してコードを書くこと。LLMは、あなたがすることすべてを吸収して、あなたに返すスポンジです。だから、それが良いものであることを確認してください。