Global Commenting

What problem does it solve?

This Skill tackles the issue of outdated, redundant, or missing code comments that hinder understanding and maintainability. It promotes a philosophy of self-documenting code, ensuring comments are minimal, precise, and only used for complex logic, saving developers time deciphering code.

Core Features & Use Cases

• Self-Documenting Code: Prioritizes clear naming and structure over excessive comments.
• Targeted Commenting: Guides when and how to add comments for complex algorithms or business logic.
• Use Case: When reviewing a complex PHP function, use this skill to ensure the AI adds PHPDoc blocks for parameters and return types, and only adds inline comments for non-obvious business logic, while removing any redundant comments.

Quick Start

Refactor the 'calculateDiscount' function to be more self-documenting and add PHPDoc comments only where necessary for complex logic.