JS中的文档注释

作者:xie392地址:https://v.douyin.com/ie9n8uDC/更新时间:2024-12-23

安装

1
npm install -g jsdoc

例子

example.js

1
/**
2
* @description: 计算两个值的和
3
*
4
* @param {number} a 参数一
5
* @param {number} b 参数二
6
* @returns {number} 返回值
7
*/
8
function add(a, b) {
9
return a + b
10
}

生成文档

控制台输入 jsdoc ./doc