skip_jsdoc

当附加到函数或方法时,阻止 wasm-bindgen 自动生成 JSDoc 样式的文档注释。默认情况下,wasm-bindgen 会向生成的 JS 文件中的文档注释添加 @param@returns 注释。skip_jsdoc 注释会阻止这种情况,允许您提供自己的文档注释。

以下 Rust 代码使用 skip_jsdoc 来省略一个自动生成的文档注释。

#![allow(unused)]
fn main() {
use wasm_bindgen::prelude::*;

/// Autogenerated docs.
#[wasm_bindgen]
pub fn foo(arg: u32) -> u32 { arg + 1 }

/// Manually written docs.
///
/// @param {number} arg - A descriptive description.
/// @returns {number} Something a bit bigger.
#[wasm_bindgen(skip_jsdoc)]
pub fn bar(arg: u32) -> u32 { arg + 2 }
}

上述代码的 wasm-bindgen 生成的 JS 接口将如下所示:

/**
* Autogenerated docs.
*
* @param {number} arg
* @returns {number}
*/
export function foo(arg) { /* ... */ }

/**
* Manually written docs.
*
* @param {number} arg - A descriptive description.
* @returns {number} Something a bit bigger.
*/
export function bar(arg) { /* ... */ }