Tsdoc Comments

What it does

The tsdoc-comments skill enables AI agents to generate, understand, and modify TypeScript documentation comments (TSDoc). It can automatically create JSDoc style comments for functions and classes, update existing comments based on code changes, and ensure consistency in comment formatting. This helps maintain clean, well-documented TypeScript projects.

When to use it

• Automated Documentation: Generate initial TSDoc comments for a new TypeScript project or codebase.
• Comment Updates: Automatically update documentation when function signatures or class structures change.
• Code Review Assistance: Ensure consistent comment formatting and style across a team's code base during code reviews.
• Refactoring Support: Update TSDoc comments to accurately reflect changes made during refactoring efforts.

Key capabilities

• Generates JSDoc-style comments.
• Updates existing documentation based on code modifications.
• Maintains consistent comment formatting.

Example prompts

• "Generate TSDoc comments for this function: function calculateSum(a: number, b: number): number { return a + b; }"
• "Update the JSDoc comment to reflect the new parameter type in this function signature."
• “Ensure all comments follow the team’s established style guide.”

Tips & gotchas

This skill is most effective when integrated into an automated build or code review process. It requires a TypeScript project as input and may need configuration to align with specific documentation styles.