jsdoc
Skill2 starsChanged 54 days agoMITView on GitHub
Writes or reviews TypeScript JSDoc comments with the house format, tags, ordering, and @example styles. Use when adding or checking doc comments on exports, options, or public APIs, or when asked to document a TypeScript file.
4 other projects use a version of this.
Adopted by
Most recently taken up by
- yamcodes/arkenvtheir own version, first seen Oct 8, 2026
- ivklgn/ai-kittheir own version, first seen Sep 4, 2026
- ivklgn/bag-of-skillstheir own version, first seen Sep 4, 2026
- CorentinGC/claude-skillstheir own version, first seen Mar 7, 2026
Other versions4 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 4
- yamcodes/arkenv★ 151same name
- ivklgn/ai-kit★ 12same name
- ivklgn/bag-of-skills★ 12same name
- CorentinGC/claude-skills★ 0same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
The file
We split this skill into the rules it gives an agent
2 rules. 0 are common, 1 is distinctive, and 1 is very specific to this project.
0
Common
Most of the 3 edited versions we read keep these.
1
Distinctive
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 11
Write doc comments that say what a member does, in a shape TypeScript does not already give.
- Very specific: line 36
Never @param, @returns, @type, or @typedef: they repeat the signature.
“Common” is measured: kept by at least 6 in 10 of the 3 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
JSDoc
Write doc comments that say what a member does, in a shape TypeScript does not already give.
1. Decide whether a member needs one
Comment an exported type, property, or function only when the comment adds what the name and signature do not. Skip the ones whose name says it all.
2. Write the description
Say what the member does, not its type, in full sentences. Always use a multi-line /** ... */
block with the description on its own line, and expand any one-line block. For a default, an enum,
nested properties, or a function, follow the pattern in
references/examples.md.
3. Add tags, in this order
- Description
- A bullet list of variants or behaviors, if any
@default, only for a non-obvious default. Never@default false, and never@default undefined, which?already implies@example, one concern per example, for complex or multi-variant APIs@note, for a caveat such as version info or a breaking change@deprecated, with the migration path@see. Use@internaland@betasparingly
Never @param, @returns, @type, or @typedef: they repeat the signature. Put that
information in the type itself.
Output
The doc comments in the file, or one line saying nothing needed one. For a review: one bullet per member, its name and what is missing or wrong.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.