{"id":1216,"kind":"story","title":"AIが書いたコードコメントによく見られる残念な9パターン","url":"https://qiita.com/jnchito/items/636c519c0b1d347c79b7?utm_campaign=popular_items&utm_medium=feed&utm_source=popular_items","host":"qiita.com","by":"startupxo","score":0,"comments":1,"editorial_comments":1,"time":"2026-11-01T00:48:29.059Z","origin":"curated","language":{"source":"ko","reading":"ja","translated":true},"summary":["コードを読めばわかる内容をそのまま説明するコメントが多い。原文はそうしたコメントを削除し、本当に必要なときだけ、なぜそうするのかを書くよう勧めている。","コメントは説明対象のコードのすぐ前に置くべきだ。メソッド内の特定の処理についての説明をメソッド定義の直前に書くと、関数全体の説明と誤解されやすい。","過去の変更履歴や特定の呼び出し箇所といった情報は、コードコメントよりもコミットメッセージ、プルリクエストの説明、呼び出し側のコメントに書く方がよいと原文は説明している。","原文の筆者は、AIが書いたコメントをそのまま信用せず、人が確認すべきだと述べている。また、コメントのルールをCLAUDE.mdのようなAI向けの指示ファイルにまとめる方法も提案している。"],"discussion":"https://startupxo.com/ja/1216/","markdown":"https://startupxo.com/ja/1216.md","api":"https://startupxo.com/api/v1/item.json?id=1216&lang=ja","text":null,"edited":null,"sources":[{"site":"rss","name":"Qiita","url":"https://qiita.com/jnchito/items/636c519c0b1d347c79b7?utm_campaign=popular_items&utm_medium=feed&utm_source=popular_items","score":null,"comments":null,"observed_at":"2026-11-01T00:48:02Z"}],"thread":[{"id":487,"by":"startupxo","score":0,"time":"2026-11-01T00:48:29.059Z","text":"O: Rubyで書かれたコードレビューで、AIが付けたメソッド定義の上のコメントが機能全体の説明なのか、特定の処理の説明なのか迷うチームメンバーが、原文の二番目の基準に従ってコメントの位置を移してみる場面で、この記事は役立ちます。\nX: 原文は筆者個人のRubyの例とレビュー経験に基づくため、他の言語やチームのルールにそのまま当てはめる前に、文脈の違いを確認する必要があります。","editorial":true,"replies":[]}]}