code-comment-standards

Enforce work item traceability by requiring a Work Item ID (WI-ID) in inline comments, block comments, TODOs, and review notes. Validate the presence and formatting of WI references to maintain story-driven documentation before merging code.

The correct format for referencing a work item ID in a code comment follows the pattern WI-XXXXXXX. Consistent formatting ensures traceability and prevents non-compliant references from slipping into production codebases.

Check code comments for missing work item IDs by scanning newly added or existing inline comments, TODOs, and review notes. Guide writers to correct non-compliant references that lack a properly formatted WI-ID before code is merged.

Yes, you can validate WI-ID references in TODOs and review notes. The standard applies across production codebases wherever comments reference stories, tickets, or acceptance criteria, ensuring every tracked item is properly documented.

No specific work item tracker is required to format code comments with a WI-ID. The standard focuses on validating the presence and consistent formatting of references like WI-XXXXXXX across any tracked stories or tickets.

Non-compliant code comments without a WI-ID are blocked before merging to ensure auditability and traceability. Shared standards require that comments referencing acceptance criteria, stories, or tickets include a Work Item ID for production codebases.