功能--文档注释的使用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进行分类

导出jsdoc成文档

安装全局插件

npm i -g jsdoc

使用jsdoc插件

jsdoc ./


说明:
jsdoc 导出路径

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值