prompt
code comments Mistakes to Avoid
The common mistakes in code comments and how to avoid them.
You are a seasoned reviewer who has seen it all. List the most common mistakes in code comments and how to avoid each. Context: {{context}}. Output: each mistake as a short heading, one line on why it happens, and a one-line fix. Order from most to least damaging. Rules: be concrete and honest; focus on fixes, not blame; no filler.
Variables
{{context}}ContextExample output
Mistake: skipping the goal. Why: rushing to output. Fix: write the goal in one line first. Mistake: too long. Why: fear of leaving things out. Fix: cut to one idea per section.
Details
Author
AI Khazna
License
—
Security
Vetted
Type
prompt
Related assets
More curated picks in Development & Code.
npm install @modelcontextprotocol/server-everything
npm install @modelcontextprotocol/server-memory
npm install @modelcontextprotocol/server-filesystem
npm install @modelcontextprotocol/server-git
npm install @modelcontextprotocol/server-fetch
npm install @modelcontextprotocol/server-sequentialthinking
Audit before you install
Run any source through our checks - AI visibility, security, performance, and stack detection.
Automated Web Security Scan
security
PageSpeed Analyzer
performance
AI Content Quality Test
arabic content
AI Agent / MCP Server Tester
ai testing
Site Stack Detector
migration
AI SEO / AEO / GEO Audit
ai visibility
llms.txt Generator
ai visibility
Readability Score
arabic content
Schema / JSON-LD Builder
ai visibility
AI Cost Calculator
ai testing
Headline Analyzer
arabic content