accelint-ts-documentation

To audit JSDoc comments in a TypeScript project, you can analyze source files to identify missing tags like @param, @returns, @example, and @throws across functions, classes, types, and constants. This process ensures comprehensive API documentation standards and consistency.

Standardizing TODO and FIXME markers in TypeScript code involves scanning the codebase to detect missing comment markers, remove dead code comments, and ensure proper comment placement. This approach maintains consistent comment quality and tracking across your project.

Adding JSDoc comments for TypeScript generic functions and overloaded methods requires applying edge-case guidance for complex object parameters. You must validate proper tag placement and code fence usage against reference markdown files to document type signatures accurately.

Yes, you can audit a TypeScript codebase with no existing comments. The process checks functions, classes, types, and constants to add missing JSDoc comments from scratch, ensuring required tags are present and comment markers are consistent.

Validating TypeScript documentation standards requires access to source files and reference markdown files, specifically jsdoc.md and comments.md. These references are used to validate JSDoc tags, code fence usage, and proper comment placement during the audit.