Enforce comment formatting rules for Go and general programming projects.
npx skills add https://github.com/abhinav/home --skill writing-comments
Please help me install this Agent Skill. Skill: writing-comments Source: https://github.com/abhinav/home/tree/main/.claude/skills/writing-comments Command: npx skills add https://github.com/abhinav/home --skill writing-comments
This Skill eliminates inconsistent, unclear, or unnecessary code comments that lead to confusion and maintenance headaches, ensuring every line of documentation adds value and clarity.
// Start dispatcher
// Start the dispatcher.
// Workers must be spawned before sending the first event // or there will be a deadlock. for i := 0; i < numWorkers; i++ { go worker() }
High-intent search queries and answers about installing and using this skill.
Consistent code comments follow standardized formatting: standalone comments start with capitalization and end with punctuation, inline comments start lowercase, and multi-line comments use // on each line. This uniform style improves readability and makes your codebase easier to maintain.
GoDoc conventions require documentation comments on exported items to start with the function name and explain purpose clearly. This generates automatic documentation and signals to developers what's publicly available in your package.
Comment non-obvious logic, explain the 'why' behind complex decisions, and document gotchas like potential deadlocks. Avoid comments on self-explanatory code; focus on rationale and context that source code alone cannot convey.
Yes. Apply comment formatting rules to enforce consistent style across contributions, ensuring standalone comments have proper capitalization and punctuation, GoDoc formats are correct, and inline comments follow lowercase conventions without manual review.
Comment formatting rules apply to both Go and general programming projects. While GoDoc is Go-specific, core principles—capitalization, punctuation, multi-line structure, and value-driven comments—transfer across languages to boost code quality and maintainability.
praetoriansentryConvert source code files into markdown documents using a comment prefix.
dwaynimayGenerate one-line code review comments with severity tags and fixes.
ai-enhanced-engineerAutomate Python code quality checks using the Ruff linter and formatter.
aakash-dharGenerate docstrings, READMEs, and API documentation for code.
