コードプロンプト集｜開発ワークフローを効率化するテンプレート
コード生成、リファクタリング、バグ調査、テストケース作成、リードミーやドキュメント生成など、
開発者・ノーコードユーザーの双方が使える「コード専用プロンプト」をまとめています。
1. コード生成・雛形作成プロンプト
ゼロからコードを書くのではなく、土台となる雛形をAIに書かせるためのプロンプトです。
ユーティリティ関数の雛形を作る
ちょっとした処理を関数として切り出すときに使えるテンプレートです。
以下の要件を満たす関数を、＿＿＿＿＿＿＿＿（言語名）で作成してください。
【やりたいこと】：
＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿
条件：
- 関数名の候補を3つ提案
- 引数と戻り値の型を明示
- コメントで処理の流れを簡単に説明
- 可読性を優先（難しいテクニックは不要）
簡易スクリプト・CLIツールの雛形
日常業務を自動化する小さなスクリプトを書かせるためのプロンプトです。
以下の作業を自動化する簡単なスクリプトを、＿＿＿＿＿＿＿＿（言語名）で作成してください。
【自動化したい作業】：
＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿
条件：
- コマンドライン引数で対象パスや設定を受け取れるようにする
- 実行手順をコメントで説明する
- エラーが起きたときには分かりやすいメッセージを表示する
2. バグ調査・リファクタリングプロンプト
既存コードのバグ原因を探したり、読みやすさ・保守性を高めるためのプロンプトです。
バグの原因を特定するプロンプト
エラーメッセージとコード断片から、問題の発生箇所と修正の方向性を教えてもらうテンプレートです。
以下のコードとエラーメッセージを読み、バグの原因と修正案を教えてください。
【コード】：
＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿
【エラーメッセージ】：
＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿
出力：
- エラーの原因となっていそうな箇所
- なぜその問題が起きているのかの説明
- 修正方法（コード例とともに）
可読性重視のリファクタリング
動作はそのままに、読みやすさや保守性を高めるためのリファクタリングを依頼するプロンプトです。
以下のコードを、動作を変えずに「可読性と保守性」を優先してリファクタリングしてください。
【コード】：
＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿
条件：
- 意味のある変数名・関数名に変更
- 重複している処理を共通化
- コメントで意図を補足
- 変更点とその理由を最後に箇条書きで説明する
3. テストコード・ドキュメント生成プロンプト
後回しになりがちなテストやドキュメント作成を、AIに手伝ってもらうためのプロンプトです。
単体テストコードを生成する
既存の関数・クラスに対して、基本的なテストケースを用意するためのテンプレートです。
以下の関数（またはクラス）に対する単体テストコードを作成してください。
【対象コード】：
＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿
条件：
- 正常系と代表的な異常系のテストを含める
- どのテストがどのケースを検証しているか分かるようにコメントを書く
- ＿＿＿＿＿＿＿＿（テストフレームワーク名：例：pytest, JUnit 等）を使用する
Docstring・関数説明文を生成
引数や戻り値を明示したDocstringや説明文を書かせるプロンプトです。
以下のコードに対して、Docstring と簡単な説明文を追加してください。
【コード】：
＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿
条件：
- ＿＿＿＿＿＿＿＿（例：Googleスタイル / NumPyスタイル）のDocstring形式
- 引数・戻り値・例外を明示
- 関数の役割を1〜2行で説明するコメントも追加
4. コード解説・学習用プロンプト
他人のコードやライブラリの使い方を理解するための「解説系プロンプト」です。
コードの動作を丁寧に解説してもらう
長めのコードや初めて見る記法を理解するときに使えるプロンプトです。
以下のコードが何をしているのか、初心者にも分かるように説明してください。
【コード】：
＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿
条件：
- 全体の概要を最初に説明
- 重要な部分ごとに分けて解説
- 使用しているライブラリや関数の役割も簡単に触れる
- 例え話や図解イメージがあればそれも併せて説明する
まとめ：コードプロンプトの活用方法
「AIに丸投げしてコードを書かせる」のではなく、「雛形・案・説明」を作ってもらい、
最終的な品質・安全性の確認は必ずあなた自身が行う、というスタンスがおすすめです。
このページのプロンプトをベースに、よく使う言語やフレームワークに合わせてカスタマイズしていくことで、
あなた専用の「開発アシスタント」としてAIを活用できるようになります。
Views: 0