功能--文档注释的使用jsdoc

 常用的文档注释

/**
 * @Author: [xuyan]
 * @description: 对数组内容按需进行分类
 * @param {array} array 进行分类的数据数组
 * @param {'string' | 'function'} rules 分类规则
 * @return {object} object 分类后的数组
 * @example
 * groupBy(user,'id') //按照id进行分类
 * groupBy(user,item=>item.id) //按照id进行分类
 */
function groupBy(array, rules) {
	if (typeof rules === "string") {
		//字符串转换成函数eval(str)
		rules = eval(`(item)=>item.${rules}`);
	}
	const result = {};
	for (const item of array) {
		const key = rules(item);
		if (!result[key]) {
			result[key] = []; //--->>{key:[]}
		}
		result[key].push(item);
	}
	return result;
}

类型	作用	用法
@Author	标明作者	@Author: [xuyan]
@description	函数说明	@description: 对数组内容按需进行分类
@param	函数参数{'类型'}	@param {array} array 进行分类的数据数组
	多个参数类型	@param {'string' | 'function'} rules 分类规则
@return	返回类型	@return {object} object 分类后的数组
@example	函数是使用例子	@example  * groupBy(user,'id') //按照id进行分类  * groupBy(user,item=>item.id) //按照id进行分类

对对象参数的属性进行注释

/**
 * @description: ceshi
 * @param {object} data 数据
 * @param {string} data.name 名字
 * @param {number} data.age 年龄
 */
export function showInfo(data){
    console.log(data)
}

导出jsdoc成文档

安装全局插件

npm i -g jsdoc

使用jsdoc插件

jsdoc ./


说明：
jsdoc 导出路径