TypeScript · maintainability

no-restated-comment

eslint:no-restated-comment

Flag a single-line comment whose every word already appears on the statement below it.

Why

A comment that only repeats code adds no context and can become stale independently.

Delete the comment or replace it with the reason, constraint, or consequence absent from the code.

Executed by this rule’s unit tests.

Before

src/cache.ts · focus

// Serialize key
const key = serialize(input);

After

src/cache.ts · focus

// Serialize because the cache key is stable across deploys.
const key = serialize(input);

Directives, protected references, questions, multi-line prose, comments with novel content, and generated files are excluded.

restatesLineBelow