JSDoc注释

目录

快捷键方法

在 VS Code 中

注释的作用示例

更完整的 JSDoc 示例

常用的 JSDoc 标签

安装扩展增强功能

---

JS中除了简单的 // 单段注释还有种非常便捷并且全面的针对函数的 ​​JSDoc 注释​​： 

快捷键方法

在 VS Code 中

​​最常用的方法：​​ 在函数的上一行输入：

/**

然后按 Tab键或 Enter键，VS Code 会自动展开完整的 JSDoc 结构。

​​更快捷的方式：​​

1. 将光标放在函数名所在行（printFirstname这一行）

2. 按下快捷键：Ctrl + Alt + D（Windows） 或 Ctrl + Cmd + D（Mac）

3. 或者输入：/**然后按 Enter

注释的作用示例

在引用该方法的时候能够清楚的看到你所注释的内容

更完整的 JSDoc 示例

您可以进一步补充注释内容：

class CustomerDetails{/*** Prints the first name and optionally combines with last name* @param {string} lastname - The last name of the customer* @returns {void} This function does not return anything* @example* const customer = new CustomerDetails();* customer.printFirstname("Zhang");*/printFirstname(lastname){console.log('Ye')}
}

常用的 JSDoc 标签

标签	说明	示例
@param	参数说明	@param {string} name - 用户名
@returns	返回值说明	@returns {boolean} 是否成功
@throws	可能抛出的错误	@throws {Error} 参数错误时
@example	使用示例	@example funcName('test')
@deprecated	标记已弃用	@deprecated 请使用新方法

安装扩展增强功能

在 VS Code 中安装以下扩展可以获得更好的 JSDoc 支持：

• ​​Document This​​ - 一键生成 JSDoc 注释

• ​​JSDoc Comment​​ - 提供完整的 JSDoc 支持

养成写 JSDoc 的好习惯，特别是在团队项目中。这不仅能提供更好的代码提示，还能自动生成 API 文档，极大提高开发效率。