jsdoc

To document side effects and ownership transfer in JSDoc, use standardized tags like @remarks and @throws to capture behavioral contracts that TypeScript types cannot express, placing a single verb-phrase summary sentence directly above the exported symbol.

The best way to format JSDoc for reactive state and nullability is enforcing a one-line verb-phrase summary followed by structured tags such as @param, @returns, and @remarks, aligning with jsdoc.app conventions to clarify caller intent and mutation behavior.

Document constructor behavior and failure modes in JSDoc by placing a /** ... */ block immediately before the class constructor, using a one-line summary and @throws tags to detail explicit error semantics and lifetime expectations for callers.

You need JSDoc alongside strict TypeScript types because types cannot express caller intent, ordering, concurrency context, or JS-only versus NAPI behavior, requiring structured JSDoc tags like @remarks and @example to fill these specific behavioral contract gaps.

Include a runnable @example tag in JSDoc when the API involves complex reactive state, domain data structures, or error semantics where a literal code snippet is necessary to demonstrate stable behavior and prevent caller misunderstanding.

Yes, you can use standard JSDoc tags to document ordering and concurrency context for developer tooling by applying @remarks to detail the specific execution sequence and concurrency expectations that TypeScript signatures fail to capture.