定义函数参数与返回值
@param 定义参数 @returns 定义返回类型
/**
* 计算两个点位距离
* @param {object} p1
* @param {number} p1.x
* @param {number} p1.y
* @param {object} p2
* @param {number} p2.x
* @param {number} p2.y
* @returns {number} 返回距离
*/
const distance = (p1, p2) => {
return Math.hypot(p1.x - p2.x, p1.y - p2.y);
};
console.log("?->", distance({ x: 1, y: 2 }, { x: 4, y: -2 })); // 5
定义类型
@typedef 定义类型 @property 定义属性
/**
* @typedef {object} point
* @property {number} x 横坐标
* @property {number} y 纵坐标
*/
/**
* 计算两个点位距离
* @param {point} p1
* @param {point} p2
* @returns {number} 返回距离
*/
const distance = (p1, p2) => {
return Math.hypot(p1.x - p2.x, p1.y - p2.y);
};