通常プログラミング

コード規約に基づいたレビューを行うプロンプト

コードの品質とバグ修正を実現するためのコードレビューと修正案ガイド

コードレビューを行い、開発者が書いたコードの品質を向上させるとともにバグを修正するための指導的アドバイスを提供する。

このプロンプトでは、開発者が書いたコードと設定されたコード規約を用いて、コードに対する詳細なレビューを行い、具体的な修正案を提案する。コードの可読性、保守性、およびドキュメンテーションの改善を目指し、友好的スタイルと軽快なトーンでフィードバックを行う。

プロンプト本文

#前提条件
タイトル: コードレビューと修正案の作成
依頼者条件: コードレビューを行い、修正案を作成する必要がある人
制作者条件: コード規約に基づいてコードレビューと修正案の作成ができる人
目的と目標: 開発者が書いたコードの品質向上とバグの修正を行うために、コードレビューと修正案を作成する
リソース:
- 開発者が書いたコード
- コード規約
評価基準:
- コード規約に適合しているかどうか
- バグやエラーがないかどうか
- コードの可読性や保守性が高いかどうか
明確化の要件:
1. コード規約に基づいてコードレビューを行う
2. 不適切な変数名や関数名、コメントの修正案を提案する
3. バグやエラーを特定し、修正案を提案する
4. コードの可読性や保守性を向上させるための修正案を提案する
5. コメントやドキュメンテーションの不足を特定し、修正案を提案する

#実行命令:
以下の要件を満たし、コードレビューを実施し、修正案を{参考フォーマット}に沿って提案してください:
- {レビュー対象のコード}に対してコード規約に基づいた詳細なレビューを友好的スタイル、軽快なトーン行う。
- レビューは{レビュー対象のコード}にコメントアウトで分かりやすく書き込む。
- 修正後のコードには余計なコメントを含めず、レビューを書き込んだ元のコードとはコードブロックを分けて出力する。
- 不適切な変数名や関数名があれば、より可読性と保守性を高めるための改名を提案する。
- {コード規約}に違反している箇所を特定し、コード規約に準拠する形で修正案を作成する。
- バグまたは修正可能な問題を特定して修正する具体的な提案を行う。
- ドキュメンテーションが不足している部分や不明瞭な箇所を指摘し、追記や改善のための推奨事項を提供する。

#参考情報
レビュー対象のコード ="

"

コード規約 ="

"

参考フォーマット ="
## コードレビュー
## 修正後のコード
"
#補足:
- 指示の復唱はしないてください。
- 自己評価はしないでください。
- 結論やまとめは書かないください。
削除キー: