WASM-Bindgen 中 JSDoc 与 TypeScript 类型注解的同步优化

在 Rust 与 WebAssembly 的交互开发中，WASM-Bindgen 作为关键工具，负责生成 JavaScript 绑定代码。目前，它在处理 JSDoc 注释和 TypeScript 类型注解方面存在一些值得优化的空间。

现状与问题

当前 WASM-Bindgen 自动为函数生成包含类型信息的 @param 和 @return JSDoc 注释，或者通过 skip_jsdoc 属性完全跳过生成。这导致两个主要问题：

1. 用户自定义的 JSDoc 类型注解在 TypeScript 中被忽略
2. 自动生成的 JSDoc 注释会与用户自定义的注释产生冲突

这种机制使得开发者要么忍受自动生成的注释覆盖自己的文档，要么完全禁用 JSDoc 生成功能。

改进方案

提出的解决方案是通过智能同步 JSDoc 和 TypeScript 类型注解，具体规则如下：

1. 对于未文档化的参数或返回值，自动生成带有类型注解的 JSDoc 标签
2. 对于已文档化但无类型注解的部分，补充类型信息
3. 对于已有类型注解的部分，尊重用户定义的类型

这种同步机制不仅解决了现有问题，还带来三个额外优势：

1. 减少了对 skip_jsdoc 的需求，因为自动生成不再干扰用户定义
2. 避免了用户意外标注错误类型的风险
3. 为用户提供了对每个字段、参数和返回值的完全类型控制权

技术实现考量

实现这一功能的主要挑战在于 JSDoc 的解析。JSDoc 语法相对复杂，且用户提供的注释可能存在格式问题。虽然可以使用现有的解析库，但考虑到项目对依赖的严格控制，可能需要实现一个轻量级的专用解析器。

从技术角度看，这个同步过程可以分为两个独立部分：

1. 将 TypeScript 类型信息补充到现有 JSDoc 注释中
2. 将 JSDoc 中定义的类型应用到 TypeScript 类型声明

即使只实现其中一部分，也能显著改善当前状况。

兼容性与扩展性

这类变更主要影响注释和类型声明，不会破坏现有功能。对于格式不正确的 JSDoc，建议先以警告而非错误形式处理，为后续升级留出空间。

从长远看，这种处理 JSDoc 的方式为支持更多高级类型特性奠定了基础，包括泛型(@template)、自定义类型定义(@typedef)和函数重载(@overload)等。这些特性都能通过 JSDoc 标签以符合 JavaScript 开发者习惯的方式实现。

总结

通过同步 JSDoc 和 TypeScript 类型注解，WASM-Bindgen 可以在保持现有功能的同时，提供更灵活的类型控制能力，改善开发者体验。这种改进既尊重了 JavaScript 生态的现有实践，又为未来的功能扩展提供了清晰的技术路径。