利用 jsDoc 的好处有助于提升代码可读性的提升在 IDE 开拓工具里可以得到更好的代码提示对付框架开拓，书写好的 jsDoc 可以直接天生 API 手册

我们常用的 vscode 实在内置了 jsDoc，只需输入 / 然后就会有提示，然后直接按回车就可以天生了：

/ @function 打算两个数之和 @params {number} a @params {number} b @returns {number} 两数之和 /function addNumber(a, b) { return a + b}jsDoc 插件

可以借助 jsdoc 插件工具，根据我们的 js 文件天生 API 文档：

php去除js注释JavaScript代码注释利器jsDoc Java

# 全局安装npm install -g jsdoc# 根据注释天生文档网页jsdoc ./demo.js