常用注释关键字
| 注释名 | 语法 | 含义 |
|---|---|---|
| @function | @function 简要描述 | 用于定义当前对象是一个函数，后面可跟描述 |
| @description | @description 描述信息 | 用于描述 |
| @param | @param {参数类型} 参数名 - 描述信息 | 描述参数的信息 |
| @return | @return {返回类型} 描述信息 | 描述返回值的信息 |
| @author | @author 作者信息 [附属信息：如邮箱、日期] | 描述此函数作者的信息 |
| @version | @version XX.XX.XX | 描述此函数的版本号 |
| @example | @example 示例代码 | 演示函数的使用 |
/**
* @function 处理str
* @description 描述fn函数功能
* @param {String} st - 字符串
* @return {String}
* @author yanghui 2022/07/06
* @version 1.0.0
* @example
* fn(str)
*/
function fn(str) {
return str
}