skip_jsdoc

當附加到函式或方法時,會阻止 wasm-bindgen 自動產生 JSDoc 風格的文檔註解。預設情況下,wasm-bindgen 會將 @param@returns 註解新增到產生的 JS 檔案中的文檔註解。skip_jsdoc 註解可以防止這種情況,讓您可以提供自己的文檔註解。

以下 rust 使用 skip_jsdoc 來省略其中一個自動產生的文檔註解。


# #![allow(unused_variables)]
#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) { /* ... */ }