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. Use when this capability is needed.

tomevault-io Updated

File contents

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


Converted and distributed by TomeVault — claim your Tome and manage your conversions.

tomevault-io/skills-registry/tree/main/dpietersz--n8n-nodes-pleo--global-commenting commit fcd7916066

Frequently asked questions

npx skillmds@latest add tomevault-io/global-commenting-3