コードレビュープロンプトは、こんなときに役立ちます。コードは動くのに、問題が潜んでいないか確信が持てないときです。「このコードを見て」とだけ頼むと、ほめられるか、全部書き直されるかのどちらかになりがちです。チェック範囲、深刻度、出力形式をプロンプトに書いておけば、レビュアーのように指摘してくれます。まず直すべきところ、次によくできるところの順です。
まずこのプロンプトをコピーしてください
あなたは今、[プログラミング言語]に詳しいベテランのコードレビュアーです。[コードの用途]のコードをレビューした経験があります。
最後に貼ったコードだけをレビューしてください。貼られていないコードについては推測しないでください。
次の順番でチェックしてください。1)正確性:ロジックの誤り、境界条件、空の値、例外処理。2)セキュリティ:インジェクション、過剰な権限、機密情報の漏えい。3)パフォーマンス:明らかに無駄なループ、繰り返しのクエリ、大きなオブジェクトの不要なコピー。4)可読性と保守性:命名、重複したコード、長すぎる関数。5)テストの抜け:テストされていない分岐。
まず問題の一覧を出し、次に修正案を出してください。問題ごとに深刻度、場所、問題点、直し方を書いてください。深刻度は「必ず直す」「直したほうがよい」「後回しでよい」の3つだけ使ってください。修正コードを書くのは「必ず直す」問題だけにし、それ以外は直し方だけを説明し、コード全体を書き直さないでください。不確かな点は「不確か」と書き、確定に必要な情報を示してください。最後に、最も重要な背景の質問を1つしてください。
今回は[重点的に見る点]を重点的に見て、[厳しさの度合い]で判断してください。
コード:
[コードを貼り付け]5つの角かっこはこう埋めます
- [プログラミング言語]:Python 3.12のように言語とバージョンを具体的に書きます。
- [コードの用途]:注文金額の計算、ユーザーログインの受付など、何のためのコードかを書きます。レビューの基準は用途で変わります。
- [重点的に見る点]:セキュリティ、パフォーマンス、可読性の中から1つか2つ選びます。全部選ぶと重点がなくなります。
- [厳しさの度合い]:厳しいとスタイルの問題まで挙がり、ゆるめだと正確性とセキュリティの問題だけが挙がります。
- [コードを貼り付け]:関数を丸ごと貼ります。半分だけ貼ってはいけません。200行を超える場合は分けてレビューします。
埋めた後の冒頭はこうなります
あなたは今、Python 3.12に詳しいベテランのコードレビュアーです。注文金額の計算のコードをレビューした経験があります。
今回はセキュリティと境界条件を重点的に見て、厳しく判断してください。出力がおかしいときはこう直します
- 細かい指摘が多すぎる:厳しさをゆるめに変え、「必ず直す」だけを見ます。
- 直し方があいまい:コードの呼び出し元と実際の入力例を1つ貼り、実際の経路でチェックさせます。
- AIがコードを書き直してしまう:「コードを書き直さず、問題点と直し方だけを出してください」と加えて、もう一度送ります。
「必ず直す」を先に直し、テストを通してから「直したほうがよい」を見ます。この順番なら、レビューは時間の節約になります。