code-comment-standards

You can enforce TSDoc standards by applying comment validation during development and pre-commit checks to ensure public APIs include required @param and @returns tags. This validates that public API comments are fully documented with TSDoc syntax.

The best way to remove stale phase references is to use a linting rule that detects outdated task or step mentions in comments and flags them for removal. This enforces the elimination of stale phase references, ensuring comments describe current functionality accurately.

Yes, you can use code comment standards during pre-commit checks to sustain consistent commenting practices. It is designed for software projects using TypeScript and JavaScript to validate comments before code is committed.

You can require actionable context in TODO comments by enforcing a validation rule that checks for descriptive details or explicit links. This ensures TODOs include actionable context or links to documentation, preventing vague task notes.

You link architecture details by enforcing the use of the @see tag within TSDoc comments to reference external documentation. This requires documentation links via @see for architecture details, ensuring developers can easily navigate to relevant architectural docs.

This code comment linter works with both JavaScript and TypeScript. It is designed for software projects using TypeScript and JavaScript during development, code reviews, and pre-commit checks to maintain high-quality, current code comments.