global-commenting

Write self-documenting code with minimal, helpful comments that explain logic rather than changes. Use this skill when adding comments to TypeScript files, writing JSDoc documentation, deciding whether code needs commenting, or reviewing existing comments. Apply when writing n8n node code, helper functions, or any code where you need to balance clarity with comment density.

⭐5stars🔀1forks📁View on GitHub🕐Updated Jan 11, 2026⬇️1downloads

When & Why to Use This Skill

The Global Commenting skill optimizes software development by guiding Claude to write self-documenting code and high-impact documentation. It streamlines the creation of JSDoc for TypeScript, ensures comment density is balanced for readability, and helps maintain clean codebases by focusing on the 'why' behind complex logic rather than stating the obvious. This approach reduces technical debt and improves long-term code maintainability.

Use Cases

  • Automating JSDoc generation for TypeScript projects to ensure comprehensive and standardized API documentation for better developer experience.
  • Reviewing and refactoring legacy codebases to prune redundant comments and improve clarity through self-documenting naming conventions.
  • Adding strategic inline comments to explain complex business logic or non-obvious algorithms in n8n nodes and helper functions.
  • Enforcing professional coding standards by ensuring comments focus on logic intent rather than tracking temporary fixes or trivial changes.
  • Balancing code density and readability during large-scale code migrations or architectural reviews.
nameGlobal Commenting
descriptionWrite self-documenting code with minimal, helpful comments that explain logic rather than changes. Use this skill when adding comments to TypeScript files, writing JSDoc documentation, deciding whether code needs commenting, or reviewing existing comments. Apply when writing n8n node code, helper functions, or any code where you need to balance clarity with comment density.

When to use this skill:

  • When deciding whether to add comments to code
  • When writing JSDoc documentation for functions
  • When adding inline comments to explain complex logic
  • When reviewing or cleaning up existing comments
  • When writing self-documenting code with clear naming
  • When explaining large sections of code logic
  • When avoiding comments that describe temporary changes or fixes
  • When balancing code clarity with appropriate comment density

Global Commenting

This Skill provides Claude Code with specific guidance on how to adhere to coding standards as they relate to how it should handle global commenting.

Instructions

For details, refer to the information provided in this file: global commenting