Global Commenting

Acerca de

Global Commenting provides a standardized framework for maintaining clean, high-quality code documentation in PHP, TypeScript, and JavaScript projects. By focusing on "evergreen" comments, this skill ensures that documentation explains the underlying rationale and complex business logic rather than stating the obvious or tracking temporary changes. It guides the model to favor self-documenting code structures and clear naming conventions, helping developers maintain a codebase where comments are purposeful, relevant, and easy to maintain over time.

Características Principales

• Guidance on choosing refactoring for clarity over adding comments
• Identification and removal of outdated or redundant commentary
• 0 GitHub stars
• Documentation strategies for complex data structures and array shapes
• Standardized PHPDoc, JSDoc, and TSDoc implementation guidelines
• Focus on explaining the 'why' behind non-obvious architectural decisions

Casos de Uso

• Refactoring legacy codebases to improve readability and remove stale documentation
• Documenting complex proprietary algorithms or intricate business logic
• Establishing consistent commenting standards across a multi-language repository