博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
jsdoc的简单使用
阅读量:272 次
发布时间:2019-03-01

本文共 332 字,大约阅读时间需要 1 分钟。

安装

npm install jsdoc -g

书写

jsdoc有一套自己的规范,要按规矩办事,比如下:

/** * 求两个数的积 * @param {number} x - 乘数  * @param {number} y - 被乘数 * @return {number} 积 */function multiply(x, y) {
return x * y;}

这里有个小技巧,一般ide都会支持自动补全注释,也就是最好先写好你的方法,之后再去写jsdoc的注释。比如上边的方法,再方法写好之后,再输入

/** 并按回车,就会得到以下的效果:

在这里插入图片描述
以上是vscode的注释补全。

最后运行,jsdoc会生成静态页面,拖到浏览器就可以预览了

在这里插入图片描述

在这里插入图片描述

样式还是很不错的

转载地址:http://vtjo.baihongyu.com/

你可能感兴趣的文章