writing-code-comments-and-docstrings

To generate Python docstrings, this skill creates comprehensive documentation strings for functions, classes, and modules following language-specific conventions like Google style, explaining parameters, return values, and exceptions.

The best way to add inline comments to TypeScript code is using this skill to provide explanatory annotations for complex logic, non-obvious decisions, and workarounds, ensuring code is understandable for future developers.

Yes, you can use this skill to add TODO, FIXME, HACK, and NOTE annotations to your codebase, automatically providing appropriate context and tracking information for deferred tasks and known issues.

Yes, this skill works with both Python and TypeScript, generating structured docstrings and explanatory inline comments tailored to each language's specific documentation conventions to enhance code maintainability.

You need to generate docstrings when you have implemented complex algorithms or modules and require clear explanations of functionality, implementation details, and deferred tasks to ensure the codebase remains maintainable for current and future developers.