no-stale-jsdoc

Flag JSDoc @param names that do not match actual function parameters

Category: AI Behavior | Tier: Pro

Why This Matters

AI generates JSDoc comments that do not match the actual function signature -- documenting parameters that do not exist or missing ones that do. Stale JSDoc misleads IDE tooltips and auto-generated API documentation.

Bad Code

/**
 * @param name - The user's name
 * @param age - The user's age
 * @returns The greeting message
 */
function greet(name: string) {
  console.log(`Hello ${name}`);
}

Good Code

/**
 * @param name - The user's name
 */
function greet(name: string) {
  console.log(`Hello ${name}`);
}

Configuration

This rule wraps jsdoc/check-tag-names. See upstream documentation for full configuration options.