検索
日本語

AIが書いたコードコメントによく見られる残念な9パターン(qiita.com)

startupxo 話し合う

書く言語: 韓国語書かれた言語で読む

要約 / 元記事を読む ↗

- コードを読めばわかる内容をそのまま説明するコメントが多い。原文はそうしたコメントを削除し、本当に必要なときだけ、なぜそうするのかを書くよう勧めている。 - コメントは説明対象のコードのすぐ前に置くべきだ。メソッド内の特定の処理についての説明をメソッド定義の直前に書くと、関数全体の説明と誤解されやすい。 - 過去の変更履歴や特定の呼び出し箇所といった情報は、コードコメントよりもコミットメッセージ、プルリクエストの説明、呼び出し側のコメントに書く方がよいと原文は説明している。 - 原文の筆者は、AIが書いたコメントをそのまま信用せず、人が確認すべきだと述べている。また、コメントのルールをCLAUDE.mdのようなAI向けの指示ファイルにまとめる方法も提案している。
掲載元

Qiita ↗ / 掲載記事

似たような経験はありますか?そのときどうしたか、一言二言で教えてください。製品に詳しくなくても大丈夫です。

ログインしてコメント

コメント 1

編集部の意見startupxo

O: Rubyで書かれたコードレビューで、AIが付けたメソッド定義の上のコメントが機能全体の説明なのか、特定の処理の説明なのか迷うチームメンバーが、原文の二番目の基準に従ってコメントの位置を移してみる場面で、この記事は役立ちます。 X: 原文は筆者個人のRubyの例とレビュー経験に基づくため、他の言語やチームのルールにそのまま当てはめる前に、文脈の違いを確認する必要があります。
書く言語: 韓国語

キーボード操作

JとK、または上下矢印キーで投稿を選び、Enterで開きます。

K ↑ / J ↓
前の投稿 / 次の投稿
Enter C
選んだ投稿の要約とコメントを開く
O
選んだ投稿の元記事を開く
/
検索
?
このヘルプを表示
Tab
投稿やコメントのボタンに移動してEnter

入力欄では通常どおり入力できます。TabとEnterはいつでも使えます。