Does JSDoc === TSDoc from a type checking perspective?
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
Hey all!
I've been a happy user of JSDoc to power type checking with TypeScript in JS files.
https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html
I'm curious to understand what the relationship of TSDoc is / could be to powering the type checking. Will TSDoc just work™️ in the same way JSDoc does?
Forgive me if this is a silly question, I'm new to TSDoc and I haven't seen anything in the current docs / issues that discusses this.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked TypeScript JSDoc supported-types documentation, then review the TSDoc documentation and related issues for the relationship between TSDoc and type checking. Document whether TSDoc comments work for TypeScript's JavaScript type checking, and explain any differences or limitations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 15/100