一、用express搭建一个node环境。
二、输入npm install jsdoc@"<=3.3.0",安装jsdoc
三、进入.bin目录下,jsdoc -v检查版本信息,同时确定jsdoc是否安装成功。
四、在.bin文件夹下,新建test.js 文件,输入下面代码保存。
/** * MyClass类 * @class MyClass * @constructor */
function MyClass() {
/** * a属性 * @property a * @type int **/
var a = 0;
/** 获得A的值 @memberof MyClass @method getA @param returnType {int} 要设置的值 @example ele.setReturnType('0000'); **/
function setA(a) {
this.a = a;
}
/** 设置A的值 @memberof MyClass @method getA @param returnType {int} 要设置的值 @example ele.setReturnType('0000'); **/
function getA() {
return a;
}
}
然后,jsdoc test.js 运行,看目录下是否生成out文件夹。out文件夹下,即为js的api文档。
点开相应的html,即可看到文档说明