jsdoc入门使用

在代码中添加注释

jsdoc 是目的是用来记录 JavaScript 程序或者库的 API。一般被放在代码之前，这样可以被 jsdoc 解析器识别到。

每个注释必须以 /** 开头，以 /* 或者 /*** 开头的或者超过三颗星的注释将会被忽略。

你可以这样写：

/** This is a description of the foo function. */
function foo() {
}

可以使用特殊的 jsdoc 标签来提供更多的信息。

/**
 * 返回两个数的和
 * @param {number} a - 第一个参数
 * @param {number} b - 第二个参数
 * @returns {number} 两个数的和
 */
function test(a, b) {
return a + b
}
export default test

生成注释文档

安装 jsdoc

n install -g jsdoc

执行命令

jsdoc name.js

如果你的注释有问题的话，jsdoc 会返回问题给你。

修改过后继续执行命令，会在根目录下生成一个 out 文件夹，进入 index. html 页面，即可查看我们编写的项目注释。