Claude Code Plugins

Community-maintained marketplace

Feedback

Global Commenting

@FlorianRiquelme/statamic-assets
0
0

Write self-documenting code that explains itself through clear structure and naming, add minimal helpful comments to explain large sections of code logic, and avoid comments about changes or fixes that won't be relevant in the future. Use this skill when deciding whether to add comments to code, writing comments for complex logic sections, ensuring code is self-explanatory through good naming, refactoring code to reduce the need for comments, or reviewing existing comments for relevance and clarity. This skill applies when working on any code files where you need to balance code clarity with appropriate documentation.

Install Skill

1Download skill
2Enable skills in Claude

Open claude.ai/settings/capabilities and find the "Skills" section

3Upload to Claude

Click "Upload skill" and select the downloaded ZIP file

Note: Please verify skill by going through its instructions before using it.

SKILL.md

name Global Commenting
description Write self-documenting code that explains itself through clear structure and naming, add minimal helpful comments to explain large sections of code logic, and avoid comments about changes or fixes that won't be relevant in the future. Use this skill when deciding whether to add comments to code, writing comments for complex logic sections, ensuring code is self-explanatory through good naming, refactoring code to reduce the need for comments, or reviewing existing comments for relevance and clarity. This skill applies when working on any code files where you need to balance code clarity with appropriate documentation.

Global Commenting

When to use this skill

  • When deciding whether to add comments to your code
  • When writing comments for complex logic sections
  • When ensuring code is self-explanatory through good naming and structure
  • When refactoring code to reduce the need for explanatory comments
  • When reviewing existing comments for relevance and future utility
  • When removing outdated or temporary comments about changes/fixes
  • When adding concise, minimal comments to explain large code sections
  • When choosing between writing a comment vs. refactoring for clarity
  • When working on any code files (.php, .js, .ts, .vue, etc.)
  • When balancing code clarity with appropriate documentation
  • When ensuring comments remain evergreen and informational

This Skill provides Claude Code with specific guidance on how to adhere to coding standards as they relate to how it should handle global commenting.

Instructions

For details, refer to the information provided in this file: global commenting