bilingual-jsdoc

Bilingual JSDoc generation adds Chinese and English descriptions to exported functions by matching the TypeScript signature, including @param lines with bilingual descriptions, a @returns description, and at least two usage examples.

Type-safe JSDoc alignment ensures parameter descriptions and return values match the TypeScript function signature exactly, preventing documentation drift when updating or adding utility functions.

Add bilingual descriptions by writing both Chinese and English text for each @param tag and the @returns tag, ensuring the documentation covers diverse developers reading the utility exports.

Yes, bilingual JSDoc requires at least two examples illustrating normal usage and edge cases, ensuring the documentation demonstrates practical behavior for each exported function.

Bilingual JSDoc applies to both new utilities and existing exported functions, covering documentation updates, fixes, and additions across fe-tools modules to keep the codebase documentation current.

Bilingual JSDoc is needed when maintaining accessible documentation for diverse developers across fe-tools modules, ensuring exported functions have consistent Chinese and English descriptions during updates or additions.