TSDoc is a standardized doc comment format for TypeScript that provides a specification and parser for structured documentation in code.
The tool addresses the fragmentation of documentation comment styles in TypeScript projects by establishing a unified standard similar to JSDoc but designed specifically for TypeScript's type system. It works by defining a formal specification for doc comment syntax, including standard tags like @param, @remarks, and @alpha, and providing a parser library that can read and validate these comments programmatically. This allows tools and documentation generators to reliably extract and process documentation from TypeScript source files.
Teams should adopt TSDoc if they maintain TypeScript libraries or large codebases where consistent, machine-readable documentation is important. It suits projects that want to enforce documentation standards across a team or integrate documentation generation into their build pipeline. The project includes an ESLint plugin for linting doc comments, a parser library for programmatic access, and a configuration loader for customizing TSDoc behavior per project. An interactive playground is available for learning the syntax and testing the parser.
The project maintains an active monorepo structure with separate packages for the core parser, ESLint integration, and configuration handling. Development includes regular updates to the changelog across multiple packages, indicating ongoing maintenance and refinement of the specification and tooling.
