Global Commenting

关于

This skill guides the creation of clean, maintainable codebases by emphasizing self-documenting naming conventions and structural clarity over excessive commenting. It helps identify when to refactor for readability versus when to add explanatory notes, ensuring that documentation remains evergreen and focused on logic that isn't immediately obvious. Ideal for both initial development and rigorous code reviews, it minimizes noise while preserving essential context for complex algorithms and business rules.

主要功能

• Standardizes function and class documentation for long-term codebase health
• Provides guidance on refactoring for clarity instead of adding documentation
• 0 GitHub stars
• Prioritizes self-documenting code through clear naming and structural patterns
• Distinguishes between necessary logic explanations and noise-creating comments
• Ensures comments remain evergreen and free of temporary change-related notes

使用场景

• Conducting code reviews to eliminate redundant or outdated comments
• Refining variable and function names to improve overall code readability
• Documenting intricate business logic or non-obvious algorithms