JSDoc

/** * 2、函数 * @param {string} a - 参数1 * @param {number} b - 参数2 * @returns {boolean} - 返回值 */ const sum = (a, b) => { return Boolean(a + b) } /** * 3、变 ......

JSDoc 是 JavaScript 中用于添加文档注释的一种常见方式。它是一种在注释中使用特定标记和语法来描述代码功能和用法的标准化方式。以下是 JSDoc 的主要语法规范和常见标记： 1. 基本注释语法： ```javascript /** * 这里是注释的内容。 */ ``` 2. 描述块：描 ......

## 定义函数参数与返回值 @param 定义参数 @returns 定义返回类型 ``` /** * 计算两个点位距离 * @param {object} p1 * @param {number} p1.x * @param {number} p1.y * @param {object} p2 * ......

这听起来是不是很耳熟：你想写一个小型脚本，不管是为页面、命令行工具，还是其他什么类型。你从JavaScript开始，直到你想起写代码时没有类型是多么痛苦。所以你把文件从`.js`重命名为`.ts`。然后意识到你已经打开了一个麻烦的玩意儿。 如果你在为一个网站或一个库写代码，你就需要引入编译的步骤。如 ......

1. 引言 JSDoc是一个用于 JavaScript 的API文档生成器，可以将文档注释直接添加到源代码中，JSDoc 工具将扫描您的源代码并提供一些操作，例如，生成一个 API 文档 JSDoc官网：Use JSDoc: Index JSDoc中文站点：JSDoc 入门 | JSDoc中文文档 ......