Skip to content

Inline documentation: JSDoc vs TypeScript

Jump to bottom
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.

  1. https://github.com/Microsoft/vscode/issues/57495 ->
  2. https://github.com/microsoft/TypeScript/issues/16498 ->
  3. https://github.com/microsoft/TypeScript/issues/35524

An example of a file using inline documentation can be seen here:

https://github.com/microsoft/vscode/blob/8486d683444d324eaaa53ec41e5be7b47fd47a6a/src/vs/vscode.d.ts

Examples:

  • @param
  • @return
  • [anchor text](url-here)
Clone this wiki locally