code-comments

Co-located code comments should directly accompany the logic they describe, focusing on the reasoning behind decisions rather than restating what the code does. This Skill generates file headers, function documentation, and inline explanations to clarify non-obvious design choices for humans and AI assistants.

The best way to document a complex TypeScript function is generating a clear documentation block explaining its purpose, parameters, return values, and any non-obvious design choices. This Skill provides specific language patterns for TypeScript to ensure multi-audience readability.

Yes, this code documentation approach works with Swift and Python. It supports multiple programming languages by applying specific documentation patterns for each, ensuring file headers and function docs remain consistent across different software development stacks.

Yes, AI coding assistants use inline code comments effectively when they explain the reasoning behind code decisions. This Skill optimizes multi-audience documentation so that both future teammates and AI tools can understand architectural notes and non-obvious logic within the codebase.

You need to generate architectural notes in your code files when making non-obvious design decisions that affect the broader system. This Skill helps write these notes as co-located documentation to prevent documentation drift and improve understandability for future developers.

To prevent documentation drift, you should co-locate comments and documentation directly within the code files they describe. This Skill generates clear file headers and inline explanations that live alongside the code, ensuring documentation stays synchronized with the implementation.