Global Commenting

About

This skill provides a standardized framework for writing clean, maintainable code by focusing on high-quality documentation practices. It helps determine the optimal balance between code clarity and comment density, ensuring that documentation serves to explain complex logic and provide context via JSDoc rather than cluttering files with redundant information. Particularly effective for TypeScript and n8n node development, it guides the transition toward self-documenting naming conventions and purposeful inline explanations that improve overall codebase readability.

Key Features

• Strategic inline commenting for complex logic paths
• 0 GitHub stars
• Standardized JSDoc documentation for functions and classes
• Review and cleanup protocols for existing documentation
• Guidance for writing self-documenting code with clear naming
• Comment density balancing to maintain codebase clarity

Use Cases

• Documenting complex algorithmic logic that cannot be expressed through naming alone
• Standardizing documentation across a TypeScript project or n8n community node
• Refactoring legacy code to remove redundant comments and improve naming