本文共 332 字,大约阅读时间需要 1 分钟。
npm install jsdoc -g
jsdoc有一套自己的规范,要按规矩办事,比如下:
/** * 求两个数的积 * @param {number} x - 乘数 * @param {number} y - 被乘数 * @return {number} 积 */function multiply(x, y) { return x * y;}
这里有个小技巧,一般ide都会支持自动补全注释,也就是最好先写好你的方法,之后再去写jsdoc的注释。比如上边的方法,再方法写好之后,再输入
/**
并按回车,就会得到以下的效果:
最后运行,jsdoc会生成静态页面,拖到浏览器就可以预览了
转载地址:http://vtjo.baihongyu.com/