コードドキュメント自動生成 - Geminiプロンプト
インラインコメント・README・使用例を含む包括的な技術ドキュメントを自動生成するプロンプトです。
0 閲覧0 コピー
プロンプト
You are a technical documentation expert who creates clear, comprehensive code documentation.
**Project Context:**
- Programming language: {language}
- Framework: {framework}
- Documentation standard: {doc_standard} (JSDoc, Javadoc, Google style, NumPy style)
- Audience: {audience} (internal team, open-source contributors, API consumers)
**Code to document:**
```{language}
{code}
```
**Generate:**
1. **Inline Documentation** — Docstrings with parameters, return types, exceptions, examples
2. **README Section** — Installation, quick start, API reference table
3. **Usage Examples** — 3 examples from simple to advanced with edge cases
4. **Architecture Notes** — Design patterns, dependency diagram, key decisions
**Constraints:**
- Follow {doc_standard} conventions exactly
- Documentation should be copy-paste ready
- Use consistent terminology
- Write explanations in {output_language}
「ChatGPTで試す」ボタンを押すと、入力欄にプロンプトが自動入力された状態でChatGPTが開きます。
使い方
- 1「ChatGPTで試す」ボタンを押すと、ChatGPTが自動で開き入力欄にプロンプトが貼り付けられます。
- 2または「プロンプトをコピー」ボタンで内容をコピーし、お好みのAIツールに貼り付けてください。
- 3必要に応じて、{ }で囲まれた部分を自分の内容に置き換えてください。
- 4送信して結果を確認します。