Add missing JSDoc, module-level comments, and @returns tags to codebases.
npx skills add https://github.com/gil00pita/lanify --skill documentation-gil00pita
Please help me install this Agent Skill. Skill: documentation Source: https://github.com/gil00pita/lanify/tree/main/.agents/skills/documentation Command: npx skills add https://github.com/gil00pita/lanify --skill documentation-gil00pita
Documentation gaps in codebases slow onboarding, obscure intent, and reduce maintainability. This skill targets missing JSDoc, absent module-level documentation, and missing @returns tags across functions and modules.
Identify a function with insufficient documentation and generate a concise JSDoc block including a description, parameter descriptions, and a returns section.
High-intent search queries and answers about installing and using this skill.
To add missing JSDoc during code reviews, generate concise blocks containing descriptions, parameter details, and @returns tags for exported functions and modules. This ensures intent, inputs, outputs, and edge cases are clearly documented for maintainability.
Documenting module-level comments and edge cases involves adding concise documentation that explains module intent, side effects, and specific edge-case guidance. This practice clarifies usage and reduces onboarding friction for new developers.
Yes, this documentation approach integrates with ESLint-jsdoc standards. It meets requirements for module docs, param descriptions, and return values, ensuring generated JSDoc blocks comply with standard linting rules during PRs and onboarding.
Missing @returns tags reduce code maintainability because return values become obscured. Adding these tags alongside parameter descriptions and module-level comments clarifies function outputs, preventing misuse and easing developer onboarding.
Yes, you can fix incomplete JSDoc on exported functions automatically by identifying missing blocks and generating purposeful descriptions, parameter details, and return values. This ensures every function has clear usage and edge-case guidance without manual writing.
mgd34msuAdd missing JSDoc comments and @returns tags to TypeScript and JavaScript code.
chiubakaValidate JSDoc formatting and consistency against organizational guidelines.
DavidKkEnforce consistent TypeScript/React JSDoc formatting and English-only comments.
MichealWayneGenerate bilingual Chinese and English JSDoc for exported TypeScript functions.
