介绍
在前端开发中，我们经常需要写文档来记录代码的使用方法，其中很多时候我们需要使用 JSDoc 标记来描述函数、参数、返回值等等。但是在使用 async/await 时，JSDoc 并不支持这种语法，这就导致我们在编写文档时会遇到问题。而 npm 包 jsdoc-strip-async-await 就是为了解决这个问题而生的。
jsdoc-strip-async-await 可以在生成文档时，自动将 async/await 关键字及其后面的代码块给过滤掉，以避免在文档中出现错误的格式。
在本篇文章中，我将会详细介绍 npm 包 jsdoc-strip-async-await 的使用方法，并给出一些示例代码作为参考。
安装
你可以使用 npm 来安装 jsdoc-strip-async-await
npm install jsdoc-strip-async-await --save-dev
使用方法
在使用 jsdoc-strip-async-await 时，你需要在 JSDoc 中使用 @stripasync 标记来告诉它哪些函数需要过滤 async/await。
示例代码：
-- -------------------- ---- ------- --- - ----------- - --------- ----------- - ------ -------- -- - -- -- - -------- -------- ---- -- ----- -------- --------------- - ----- ---- - ----- -------------------------- ------ ------------ -
在上面的示例代码中，我们将 @stripasync 标记用于 getUserInfo 函数，表示该函数需要过滤 async/await 关键字。
接着，在启动 JSDoc 时，你需要加上 -p jsdoc-strip-async-await 参数，这样才能让 jsdoc-strip-async-await 生效。
jsdoc -c jsdoc.conf.json -P jsdoc-strip-async-await
当你完成以上步骤后，jsdoc-strip-async-await 就已经被启用了。在生成的文档中，你会发现 async/await 关键字已经被过滤掉了，而函数的描述信息则正常显示。
结语
在本文中，我介绍了 npm 包 jsdoc-strip-async-await 的使用方法，并给出了一些示例代码。如果你在编写文档时需要使用 async/await，那么 jsdoc-strip-async-await 就是一个非常好用的工具，它可以帮助你避免出现格式错误的情况。希望这篇文章能够对你有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/69476