Bilingual JSDoc
Workflow
- •Open the target module file and locate the exported function.
- •Write JSDoc in the required format:
- •Chinese description, then English description
- •
@paramlines with Chinese and English descriptions - •
@returnsline with return description - •At least two
@exampleblocks (common case + edge case)
- •Ensure types in JSDoc match the TypeScript signature.
- •Keep wording concise and consistent with existing style.