code-comments

Standardize JSDoc comments by enforcing unified rules for symbols like exported functions and components, ensuring consistent documentation, proper placement, and mandatory @returns entries across your TypeScript and React projects.

JSDoc standards for TypeScript require documenting exported functions, components, and types while omitting types in JSDoc tags and including mandatory @returns entries to maintain consistent code documentation.

Enforce code commenting rules during reviews by checking that inline comments explain the reasoning behind code, follow maximum line-length constraints, and that all symbols have proper JSDoc placement and documentation.

Yes, you can enforce inline comment placement and line-length limits in React projects to ensure comments explain the reasoning behind code and maintain readability standards across the codebase.

Omit types in JSDoc comments for TypeScript code because the type system already handles type definitions, making redundant type annotations in JSDoc unnecessary and reducing documentation clutter.

The best way to document code intent for onboarding is to apply consistent JSDoc standards for symbols and inline comments that explain why decisions were made, reducing ambiguity and review churn.