js代码注释规范

/**
 * @description一个示例函数
 * @author 泽 pro max plus
 * @version 0.0.1
 * @param number 输入一个数字
 * @param str 输入一个字符串
 * @returns 返回相加的结果
 * @param/@argument 指定参数名和说明来描述一个函数参数
 * @returns 描述函数的返回值

 * @author 指示代码的作者

 * @deprecated 指示一个函数已经废弃，而且在将来的代码版本中将彻底删除。尽量避免使用这段代码

 * @version 指定发布版本

 * @throws @exception 描述函数可能抛出的异常的类型

 * @class 提供类的有关信息，用在构造函数的文档中

 * @constructor 明确一个函数是某个类的构造函数

 * @type 指定函数的返回类型

 * @extends 指示一个类派生了另一个类。JSDoc通常自己就可以检测出这种信息，不过，在某些情况下则必须使用这个标记

 * @final 指示一个值是常量值。要记住JavaScript无法真正保证一个值是常量

 * @default 指示参数的默认值

 */
 
export default function example(number: number, str: string) { //ts
    return number + str;
}