AIにありがちな「イマイチなコードコメント」9パターン - Qiita

はじめに 「コードはAIに書いてもらう」という人が増えてきました。 僕もそんなエンジニアの一人ですが、AIにコードを書かせていると「アプリケーション側のコードはまだいいが、コードコメントとテストコードはなんかイマイチだな」と思うことが多いです。 また、コードレビューをしていると、「たぶん、これはAIが書いたコメントをそのまま採用したんだろうな〜」と思う場面も増えました。 そこで、この記事では最近のコードレビューで指摘した「イマイチなコードコメント」を9パターン挙げてみます。 （イマイチなテストコードについてはまた別の機会に書きたいと思います） なお、コード例はRubyで書いていますが、考え方は他の言語でも同じです。 1. コードを読めばわかることをコメントしている 「コードを読めばわかること」はコメントとして残す必要はありません。 # ❌ BAD（何をやっているのかはコードを読めばわかる）

[chintaro3]

AIは人間がやっていることを真似するので、AIに学習させるソースコードをまずちゃんとしろって話なんだよなぁ

[boraneko]

人間が読まない前提だとコメントはノイズにしかならないか

[syu-m-5151]

変更前との差分を説明するコメントは、その時を知らない読者には伝わらない。現在の制約と理由を書き、呼び出し元の都合は呼び出し元へ戻す。AIの説明を足す速さより、後からコードと一緒に読めるかを点検したい。

[knok]

今時強化学習も入っているので、いまいちなのはそれが反映された結果だと思う。おそらく学習元人間コードはちゃんとしてる

[jintrick]

もうコメントはADRの参照だけで

[atsushieno]

コードコメントはAIが読むという厄介な性質を帯びつつあり、AI slop前提のプロジェクトだとまだそのまま残しておいたほうがマシかもしれないと思うことがある。人間としてはここにある通りクソコメントは撲滅したい。

[hatebu_admin]

「# 消すと何故か動かなくなる」「# おまじない」みたいなコメントを学習させるべき

[quandle]

人間がコードレビューするのっていつまでやるのかな？持って数年では。

[sakuro]

「コミット前の試行錯誤(最終的に履歴には残らない)について長々と書いたコミットメッセージ(とchangelog)」をやられたのでルールで縛ってる。

[ys0000]

コメントは本当に難しいのだろうな。欲しいコメントがそもそも絶対の正解がない。初心者はコードを読めば分かる事をコメントしがち。コメントルールは厚めにしてる。あと設計書をちゃんと書かせる。

[Nodaguti]

AIに書かせるとコメントが肥大化してコードと乖離し、自動レビューでもコメントを修正させる指摘ばかり出てくるようになってトークンが浪費されたので、一切コメントを書かずテストで保証するようにしたら快適になっ

[poponponpon]

やたらとカッコ書きで補足したがる。重要ならその内容を最初に書けよ！となる

[nguyen-oi]

コード読めばわかるのにドヤ顔でコメントつけるのAIあるあるすぎるな