Global Commenting

Acerca de

Global Commenting streamlines the documentation process by providing clear guidelines on when to write comments and when to let the code speak for itself. It helps developers maintain a clean codebase by focusing on the 'why' behind complex logic, documenting public APIs with JSDoc, and ensuring Swagger properties are appropriately localized for business requirements. By discouraging temporary markers, change logs, and obvious code descriptions, this skill ensures that documentation remains relevant and future-proof, significantly improving long-term maintainability and team collaboration.

Características Principales

• Establishes guidelines for documenting complex business logic and algorithms
• Identifies and eliminates anti-patterns like change logs and commented-out code
• Provides standardized JSDoc templates for public APIs and exported functions
• Supports language-specific Swagger API property descriptions
• Prioritizes self-documenting code over redundant explanatory comments
• 0 GitHub stars

Casos de Uso

• Reviewing code to ensure comments explain architectural intent rather than implementation details
• Refactoring legacy code to improve readability and remove technical debt in documentation
• Implementing standardized API documentation using JSDoc and Swagger decorators