documentation

To automatically add missing JSDoc comments to exported TypeScript functions, this Skill identifies undocumented code and generates standard JSDoc blocks. It targets exported functions, ensuring codebases adhere to clarity and maintainability best practices.

This tool works with both JavaScript and TypeScript codebases. It targets exported functions, modules, and classes in either language, adding module-level documentation and ensuring all return values have documented @returns tags.

The best way to ensure JavaScript modules have proper @returns tags is to automate the identification of missing tags. This Skill scans your codebase for functions with return values and automatically adds the required @returns documentation.

Yes, you can use this to integrate JSDoc generation with existing ESLint rules. The process adheres to ESLint documentation standards, ensuring the automated JSDoc comments, module-level context, and @returns tags maintain consistent formatting.

You need to add module-level documentation to TypeScript files when onboarding new developers or improving maintainability. This Skill automatically adds file-level JSDoc context, ensuring the overall purpose of each module is clearly explained.

Missing JSDoc comments are a problem for code maintainability because functions, modules, and classes lack clear explanations. This Skill solves the challenge of incomplete documentation by automatically fixing missing JSDoc and @returns tags for better understanding.