Global Commenting

Standardize code comments by applying consistent formatting rules across header blocks, inline notes, TODOs, and documentation blocks in all languages. This Skill enforces organization-wide commenting standards, ensuring uniform style, clarity, and maintainability across your entire repository.

Code comments should explain the *why* behind decisions and complex logic, not just the *what*. Include assumptions, edge cases, and underlying reasoning so future developers understand context, intent, and potential pitfalls without reconstructing the original thinking.

Yes. This Skill applies commenting standards across multi-language repositories through automated validation against your organization's global commenting policy, covering language-agnostic patterns like header tags, inline formatting, and documentation blocks.

Consistent commenting reduces friction for new developers by establishing predictable, searchable documentation patterns. Standardized header blocks, inline clarity, and structured TODOs make it faster to locate context, understand design decisions, and navigate unfamiliar code.

A global commenting policy defines format standards for header blocks with metadata, inline comments explaining logic, TODO annotation structure, and documentation blocks for functions or modules. Consistency checks and automated validation ensure all code files conform to these rules organization-wide.