Code Comment Quality Improvement

D

Daniel Okoye

@daniel-okoye

·

Transform poor code comments into meaningful documentation.

59 copies0 forks
Share this prompt:
Improve this code comment using the examples as guidance.

Examples:
Before: // increment i
After: // Skip to next order in batch - current order already processed

Before: // TODO: fix this
After: // TODO(auth-team): Replace deprecated OAuth1 flow with PKCE by Q2 2025

Before: // This is important
After: // CRITICAL: Order of operations matters - cache invalidation must precede DB write to prevent stale reads

Before: // Do the thing
After: // Calculate compound interest using the formula A = P(1 + r/n)^(nt) where P is principal from user input

Original comment: {{original_comment}}
Code context:
{{code_context}}

Provide improved comment with explanation.

Details

Category

Coding

Use Cases

Code documentation improvementComment quality reviewCode readability enhancement

Works Best With

claude-opus-4.5gpt-5.2gemini-2.0-flash
Created Updated Shared

Related Prompts

Create your own prompt vault and start sharing