inline-comments

To add rationale-focused inline comments, identify non-obvious code sections like complex algorithms or regex patterns and generate comments explaining the reasoning behind decisions. This skill produces before/after diff blocks showing the annotated changes for easier code review.

Use inline comments for non-obvious code sections where intent is hidden, such as complex algorithms, regex patterns, or workarounds marked with HACK/TODO tags. Avoid commenting obvious code where the logic is already clear from reading the implementation.

Yes, you can generate rationale-focused inline comments for JavaScript, TypeScript, Python, and similar languages that support inline comment syntax. The skill annotates complex logic and patterns across these languages while avoiding commentary on obvious code.

The best way to annotate complex algorithms is to apply rationale-focused comments only to non-obvious sections and present changes as before/after diff blocks. This approach maintains comment hygiene by avoiding obvious code commentary and highlighting intent for reviewers.

This inline commenting approach works with existing source files by identifying non-obvious sections in the current code and generating rationale-focused comments. It produces before/after diff blocks so you can review exactly what changes were made and why.

To mark workarounds and technical debt, use HACK and TODO tags within your inline comments to flag non-obvious decisions and temporary solutions. This practice maintains comment hygiene by clearly distinguishing workarounds from permanent rationale-focused explanations.