Function Documentation

Document public functions with: a brief description of what the function does, @param for each pa... Use when documenting code and APIs. Documentation category skill.

majiayu000 Updated 567 repo stars

File contents

Function Documentation

Document public functions with: a brief description of what the function does, @param for each parameter with type and description, @returns for the return value, @throws for exceptions, and @example for non-obvious usage. TypeScript types reduce documentation needs but descriptions of behavior are still valuable. Internal/private functions need less documentation.

majiayu000/claude-skill-registry-data/tree/main/development/function-documentation-omniaffix-dave-sessionguardian commit 9b5c676442

Frequently asked questions

npx skillmds@latest add majiayu000/function-documentation