-
Notifications
You must be signed in to change notification settings - Fork 514
Inline documentation: JSDoc vs TypeScript
Elliot Lee edited this page Apr 28, 2020
·
1 revision
One way of documenting JS code inline is described by https://jsdoc.app/ . However, TypeScript and VS Code don't support the @link
tag.
- https://github.com/Microsoft/vscode/issues/57495 ->
- https://github.com/microsoft/TypeScript/issues/16498 ->
- https://github.com/microsoft/TypeScript/issues/35524
An example of a file using inline documentation can be seen here:
Examples:
@param
@return
[anchor text](url-here)