skip_jsdoc
當附加到函式或方法時,會阻止 wasm-bindgen
自動產生 JSDoc 樣式的 doc 註解。預設情況下,wasm-bindgen
會將 @param
和 @returns
註解新增至產生的 JS 檔案中的 doc 註解。skip_jsdoc
註解會防止這種情況,讓您可以提供自己的 doc 註解。
以下 Rust 使用 skip_jsdoc
來省略其中一個自動產生的 doc 註解。
#![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) { /* ... */ }