Improve this page

How can I use TSDoc?

By itself, the @microsoft/tsdoc package is not a documentation solution you can use directly. It is an engine component used by other tools such as API Extractor. The NPM dependency report is an easy way to find tools that implement TSDoc.

Even if you have not enabled a documentation tool yet for your project, adopting the TSDoc conventions will make your code comments more compatible with other tools.

πŸ‘‰ To check for mistakes in your code, install the eslint-plugin-tsdoc plugin for ESLint

πŸ‘‰ To see how your comments would be rendered by a compatible documentation tool, try pasting your /** */ comment into the TSDoc Playground!

πŸ‘‰ Implementing a tool that needs to parse doc comments? The @microsoft/tsdoc package provides a professional quality parser. The api-demo folder contains sample code showing how to invoke the parser.

πŸ‘‰ Have an idea for an improvement? We’re using GitHub issues to discuss the TSDoc specification, library design, and project roadmap.