writing-code-comments-and-docstrings

You can generate Python docstrings for complex functions by applying this Skill to analyze your code structure and create comprehensive documentation. It produces clear parameter descriptions, return values, and usage examples following established conventions.

The best way to add inline comments for non-obvious logic is to generate explanations that focus on the 'why' behind workarounds and decisions. This approach ensures comments provide context for complex logic rather than simply restating what the code does.

Yes, it supports generating JSDoc and Google style docstrings for TypeScript and Python. It adheres to language-specific conventions and quality standards to ensure clarity and maintainability across your codebase.

You document API endpoints and add TODO annotations by generating standardized documentation strings and context-aware annotations like TODO, FIXME, and HACK. This adds appropriate tracking information and explanations directly within your codebase.

You need to write docstrings for maintaining code clarity when working with functions, classes, or modules that contain edge cases, complex workarounds, or non-obvious decisions. This ensures code remains understandable to current and future developers.