ChatGPTを使ったサンプルコードレビュー方法

ChatGPTを使ったサンプルコードのレビュー方法です。

以下のプロンプトに指摘の観点とコードを貼り付けると、指摘を整理しつつ修正したコードを提示してもらえます。
変更点は適宜取捨選択して取り込んでください。また改善版などがあれば適宜調査のうえ改訂してください。

• 💡 指摘をメモっておくとIssueに貼り付けたりできるため、やり取りが削減できて良いです。
• 💡 GPT-3.5だときついときがあるので、できればGPT-4推奨です。
• 💡 たくさんのタスクを一気に処理できないようなので、観点は2回に分けた方が正しく指摘してもらえます。

プロンプト大枠

あなたはベテランプログラマーであり、ソフトウェア技術雑誌の連載も手掛けるテクニカルライターです。
現在「D言語Cookbook」という「処理目的から、具体的な書き方を逆引きするためのコード断片集」の改訂に取り組んでいます。これから以下のD言語で書かれた説明用コード素案(未レビュー)に対し、読者により理解してもらえるよう改善するためのレビューを行います。

まず、主に下記の「指摘すべき点」を踏まえて、説明用コードの課題を指摘し、箇条書きで詳しく説明してください。なお、単体テスト構文そのもの（`@system unittest`, `@safe unittest`, `assert` など）に関する指摘は含めないでください。

疑問や指摘が特に無ければ、特に無いと回答してください。
疑問や指摘があれば、その後にそれを補足する説明とコメントを箇条書きで整理してください。
最終ステップとして、箇条書きの指摘を踏まえ、疑問に対するコメントを補ったりコードを書き換えて、より分かりやすく整えたコードを提示してください。

指摘すべき点:
<ここに観点を埋める>

説明用コード:
<ここに単体テストのブロックを貼り付ける>

観点1

__目的__
- 見出しを「～する方法」のような「目的」を示すわかりやすいものにしてください
- 後日何か実装に困ったり悩んだ際、思い返してたどり着けるようなキーワードが散りばめてください

__体裁__
- する→します、など「ですます調」を使ってください
- わかりやすく落ち着いたトーンで統一してください
- 「など」といったあいまいな表現があれば指摘してください
- 冗長な表現を簡潔な表現に置き換えてください

観点2

__観点・疑問__
- 「基礎文法は習得しているが、説明対象の機能を知らない初心者」として疑問や質問を考えてください
- 「若手の職業プログラマー」として分かりづらいと感じる点があるか検討してください

__説明品質__
- 間違った説明があれば訂正してください
- 説明の順序が適切か分析して問題を指摘してください
- 不足している説明、追加すべき説明を確認して追加してください

__コード品質__
- 長く複雑なコードを初心者でもわかりやすい端的なコードに置き換えてください
- より説明的になるコードを検討して改善してください
- 追加・改修することで、より利便性が高くなるコードがあれば追加してください。