一、概述:jsdoc是JavaScript的API文档自动生成工具
二、非项目中使用:
1、全局安装jsdoc
npm install -g jsdoc
2、创建js ,命名为2.js,内容如下:
/**
* HelloWorld类存储一位客人的名字,并打招呼。
*/
class HelloWorld {
constructor(){
this.firstName = '';
this.lastName = '';
}
/**
* 设置客人的姓名
*
* @param {String} lastName 姓
* @param {String} firstName 名
*/
setName(lastName, firstName){
this.lastName = lastName;
this.firstName = firstName;
}
/**
* 获取客人的全名
*
* @return {String} 客人的姓名
*/
getFullName(){
return this.lastName + ' ' + this.firstName;
}
/**
* 向客人打招呼
*
*/
sayHello(){
console.log('Hello, ' + this.getFullName());
}
}
3、使用jsdoc自动生成文档:
jsdoc 2.js
4、使用上述命令,自动生成out文件,运行文件中的index.html
三、项目中使用:
1、创建项目project-test
cd Desktop
mkdir project-test
cd project-test
npm init -y -----自动生成package.json文件
2、全局安装jsdoc
npm install -g jsdoc
3、项目中安装jsdoc
npm install --save-dev jsdoc
4、创建js ,命名为2.js,内容如下
this.lastName = '';
}
/**
* 设置客人的姓名
*
* @param {String} lastName 姓
* @param {String} firstName 名
*/
setName(lastName, firstName){
this.lastName = lastName;
this.firstName = firstName;
}
/**
* 获取客人的全名
*
* @return {String} 客人的姓名
*/
getFullName(){
return this.lastName + ' ' + this.firstName;
}
/**
* 向客人打招呼
*
*/
sayHello(){
console.log('Hello, ' + this.getFullName());
}
}
5、使用jsdoc自动生成文档:
jsdoc 2.js
6、使用上述命令,自动生成out文件,运行文件中的index.html