clean-codejs-comments

Commenting patterns that improve readability and maintainability.

Safety Notice

This listing is imported from skills.sh public index metadata. Review upstream SKILL.md and repository scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "clean-codejs-comments" with this command: npx skills add damianwrooby/javascript-clean-code-skills/damianwrooby-javascript-clean-code-skills-clean-codejs-comments

Clean Code JavaScript – Comment Patterns

Table of Contents

  • When to Comment
  • When Not to Comment
  • Examples

When to Comment

  • Explain why, not what
  • Document complex business rules

When Not to Comment

  • Obvious code
  • Outdated explanations

Examples

// ❌ Bad
// Increment i by 1
i++;

// ✅ Good
// Retry once to handle flaky network condition
retryRequest();

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Related Skills

Related by shared tags or category signals.

Coding

clean-codejs-functions

No summary provided by upstream source.

Repository SourceNeeds Review
Coding

clean-codejs-modules

No summary provided by upstream source.

Repository SourceNeeds Review
Coding

clean-codejs-objects

No summary provided by upstream source.

Repository SourceNeeds Review
Coding

clean-codejs-naming

No summary provided by upstream source.

Repository SourceNeeds Review