如何给一个 JS 函数添加注释

一、js 函数注释可以采用 JSDoc 标准，格式如下：

二、可能你的参数需要支持过多类型，可以使用 | 符合进行分割：

三、可能你的参数类型复杂，你不知道怎么写，下面我将常用类型都列出来：

• {number} 表示一个数字类型值

• {string} 表示一个字符串类型值

• {boolean} 表示一个布尔类型值

• {Object} 表示一个对象类型值

• {Array} 表示一个数组类型值

• {function} 表示一个函数类型值

• {Class} 表示一个类类型值

• {undefined} 表示一个 undefined 值

• {null} 表示一个 null 值

• {any} 表示任意类型值，不进行类型检查

• {Promise} 表示一个 Promise 类型对象

• {Iterable} 表示可以迭代的对象类型

• {Iterator} 表示一个迭代器类型对象

• {Generator} 表示一个 Generator 函数类型

• {RegExp} 表示一个正则表达式类型

• {Date} 表示一个日期类型

• {HTMLElement} 表示一个 HTML 元素类型

• {Element} 表示一个 DOM 元素类型

四、可能你的参数是一个自定义的对象，那么可以这样做，通过 @typedef 关键字来自定义类型：

五、如果，你多个函数公用一个数据类型，甚至还可以全局定义：

我相信，以上能满足你绝大多数的注释要求。如果有跟多需求，可以参考JSDoc 官方文档地址为：https://jsdoc.app/。

该网站提供了详细的 JSDoc 使用文档，包括标签的使用、类型标记、示例和配置等方面的内容，同时也提供了许多示例和 API 参考等。你可以在该网站上了解和学习如何使用 JSDoc 编写规范的 JavaScript 文档，并且在自己的 JavaScript 项目中应用。