AIコードレビューの前に、読めるコードの観点を1冊で補助する

MS-012 featured image: before-adding-ai-to-task-management - text-free editorial workplace still life Power Solutions (途切れない力)

結論

AIにコードレビューを任せる前に、人間側の「読みやすさの観点」を1つだけ持っておくと、指示が雑になりにくいです。

この記事では、書籍『リーダブルコード』を「買うべき本」として強くすすめるのではなく、AIレビューの指示を作るときに使える判断軸の参考候補として扱います。

この記事の前提

AIレビューは便利ですが、何を見てほしいかを渡さないと、表面的な指摘に寄りがちです。

たとえば、次のようなレビューは一見それっぽく見えても、実務では直し方に迷います。

  • 可読性を上げてください
  • 命名を改善してください
  • 保守しやすくしてください

問題は、言葉が大きすぎることです。AIが悪いというより、人間側が観点を小さく渡せていない状態です。

使うなら「読む観点の棚卸し」に限定する

本を読む目的を、知識の完全習得に置くと重くなります。

この用途では、次の3つだけ拾えば十分です。

  1. 変数名で何を説明すべきか
  2. 関数をどこで分けるべきか
  3. コメントが必要になるのはどんなときか

この3点を自分のプロジェクト用チェックリストに変換してから、AIに渡します。

AIレビュー用の小さな指示例

たとえば、レビュー依頼を次のように変えます。

この差分をレビューしてください。
特に、次の3点だけ見てください。
1. 変数名だけで役割が伝わるか
2. 1つの関数が複数の責務を持っていないか
3. コメントで補っている箇所を、コード側で表現できないか
重大なバグ断定ではなく、改善候補として返してください。

これくらい狭めると、AIの回答も「なんとなくきれいにしましょう」から、直せる単位に寄りやすくなります。

参考候補

この記事にはアフィリエイト広告を含みます。紹介する商品は、本文の判断基準に沿った参考候補として扱います。

注意点

この本を読めばコード品質が必ず上がる、という話ではありません。

また、AIレビューの品質も、対象コード、テストの有無、プロジェクトの設計方針によって変わります。書籍は判断軸を増やす材料であって、最終判断を外注する道具ではありません。

次にやること

まずは、自分のレビュー依頼文に次の1行だけ足すのが現実的です。

読みやすさについて、命名・関数分割・コメントの3点に絞って改善候補を出してください。

本を買うかどうかより先に、AIへ渡す観点を小さくする。そこから始めるほうが、レビューの面倒は減らしやすいです。

コメント

タイトルとURLをコピーしました