JSDoc
An ESLint plugin providing linting rules to enforce consistent and valid JSDoc comments in JavaScript and TypeScript code.
What is JSDoc?
eslint-plugin-jsdoc is an ESLint plugin that provides a comprehensive set of linting rules specifically for JSDoc comments in JavaScript and TypeScript code. It helps developers enforce consistent and valid documentation by checking for errors in tag usage, type definitions, formatting, and completeness. The plugin solves the problem of inconsistent or incorrect JSDoc comments, which can lead to poor documentation quality and reduced tooling effectiveness.
JavaScript and TypeScript developers who use JSDoc for code documentation and want to enforce consistency and correctness automatically through linting. It is particularly useful for teams working on large codebases or projects where maintaining documentation standards is critical.
Developers choose eslint-plugin-jsdoc because it offers a specialized, highly configurable set of rules tailored for JSDoc, integrates seamlessly with ESLint, and includes auto-fix capabilities for many issues. It provides pre-configured rulesets for different environments (e.g., TypeScript, TSDoc), reducing setup time and ensuring best practices.
Overview
JSDoc specific linting rules for ESLint.
Use Cases
Best For
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
