RateMyPrompt

RateMyPrompt

Discover and share the best AI prompts, rated by AI & humans

Code Documentation Enhancer

7.9/10Overall
7.9AI
No user ratings
Submitted Jul 18AI evaluated Jul 18

Prompt

Enhance code with comprehensive documentation.

<code_context>
- Language: {programming language}
- Type: {library/API/application}
- Complexity: {simple/moderate/complex}
- Users: {who will use this code}
</code_context>

<documentation_needs>
{what needs documenting}
</documentation_needs>

<code_sample>
{paste code needing documentation}
</code_sample>

Enhance with:
1. File/module level
   - Purpose statement
   - Usage examples
   - Dependencies
   - Author/maintenance info
   
2. Class/function level
   - Description
   - Parameters
   - Return values
   - Exceptions
   - Examples
   - Complexity notes
   
3. Inline documentation
   - Complex logic explanation
   - Algorithm descriptions
   - Performance considerations
   - TODO/FIXME items
   
4. External docs
   - README updates
   - Wiki pages
   - Architecture notes

Follow language-specific conventions.

AI Evaluation

How we evaluate
Claude 3 Haiku
AI Evaluation
7.8/10
GPT-4 Mini
AI Evaluation
8.0/10

User Rating

No ratings yet. Be the first to rate!

Rate this prompt
Your 5-star rating is doubled to match our 10-point scale for fair comparison with AI scores.