① 絞る
- コードを読めば分かることを、コメントに書いていないか
- 「なぜこう書いたか」の理由を、背景の情報つきでAIに渡したか
- 渡していない理由を、AIに推測で書かせていないか
- docstringを付ける範囲を、外から呼ばれる関数・公開APIから始めたか
- docstringの形式を、チームで使っているものにそろえたか
② 確かめる
- 引数の名前・順番・省略時の値が、docstringと一致しているか
- 戻り値の分岐が、コードに本当にあるか
- 書かれている例外を、コードの中で本当に投げているか
- 使用例を実際に動かしたか（
doctestやテストへの写しなど） - 「高速」「安全」などの言葉に、説明できる根拠があるか
③ 一緒に直す
- コードの変更と同じ差分で、影響するコメントも直したか
- AIに修正を頼むとき、コメントの更新もあわせて頼んだか
- レビューの観点に「振る舞いが変わった関数のdocstring」を入れたか
- 合わないコメントを、直すか消すかしたか
- TODOに持ち主と理由を付けたか
この内容は記事「AIにdocstring・コメントを書かせる｜後で嘘にならない書き方」のチェックリストです。印刷してそのままお使いいただけます。 ／ 無料ツール一覧へ