basarat / basarat/typescript-book

Jsdoc : new section request

Open
#107 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
21.6k
Forks
2.6k
PR merge metrics
No merged PRs in 30d

Description

There are some subtleties in the TypeScript flavor of jsdoc vs other flavors. Best that we cover these.

Some reference material http://typedoc.io/guides/doccomments.html

Document modules with `@module` : http://usejsdoc.org/howto-es2015-modules.html

> These came up while working on https://github.com/alm-tools/alm/issues/78#issue-154976324

Contributor guide

Open the contributing guide

Research direction

Start with the linked TypeDoc doc-comments guide and JSDoc ES2015 modules guide, then inspect the book's existing JSDoc documentation structure. Done means a new section clearly explains TypeScript-specific JSDoc subtleties and documents module usage with @module, while covering the reference material relevant to the linked alm-tools issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.