信息发布→ 登录 注册 退出

JS注解有哪些类型_ JS中常见的注解类型及其功能解析

发布时间:2025-11-18

点击量:
答案:JavaScript虽无原生注解,但通过JSDoc等工具支持的注释形式实现类似功能,如@param、@returns、@type用于类型描述,@typedef定义复杂类型,@class标识构造函数,@deprecated标记废弃方法,@async声明异步函数,@example提供示例代码,结合@see、@todo等提升可读性与维护性,配合TypeScript指令如@ts-ignore优化开发体验,最终增强代码结构与工具支持。

JS中并没有像Java那样的“注解”(Annotation)语法,但开发者常在代码中使用类似“注解”的注释形式来辅助开发、文档生成或工具识别。这些“注解”实际上是特定格式的注释,主要用于JSDoc工具解析,提升代码可读性和维护性。以下是JS中常见的注解类型及其功能解析。

JSDoc 基础注解

JSDoc 是最常用的JavaScript文档生成工具,它通过特定格式的注释为函数、类、变量等添加元信息。

@param:用于描述函数参数的类型和说明。
例如:
/\*\*
  \* 计算两数之和
  \* @param {number} a - 第一个加数
  \* @param {number} b - 第二个加数
  \* @returns {number} 两数之和
\*\/
function add(a, b) { return a + b; }

@returns@return:说明函数返回值的类型和含义。

@type:指定变量或表达式的类型。
例如:
/** @type {string} *\/
let name = "Alice";

结构与分类注解

@typedef:定义自定义类型,适用于复杂对象结构。
例如:
/\*\*
  \* @typedef {Object} User
  \* @property {string} id - 用户ID
  \* @property {string} name - 用户名
\*\/

@class@constructor:标记函数为构造函数或类。
例如:
/** @class *\/
function Person(name) { this.name = name; }

@module:标识当前文件为模块,并命名该模块。

功能与行为注解

@deprecated:标记某个函数或方法已废弃,建议使用其他替代方案。
例如:
/\*\*
  \* @deprecated 使用 newFunction 替代
\*\/

@async@generator:分别表示函数是异步函数或生成器函数。

@throws@exception:说明函数可能抛出的异常类型。

工具与框架专用注解

一些构建工具或框架也支持自定义注解(通常以@开头),用于控制行为。

@todo:标记待办事项,便于后续追踪。

@see:引用其他相关方法或文档。

@example:提供代码使用示例。
例如:
/**
  * @example
  * console.log(add(1, 2)); // 3
*\/

• 在React或TypeScript项目中,有时会看到类似@ts-ignore@ts-check的指令注释,用于控制TypeScript编译器的行为。

基本上就这些。虽然JavaScript本身不支持真正的注解机制,但通过JSDoc这类规范化的注释方式,可以实现类型提示、IDE智能补全、文档生成等多种功能,极大提升开发效率和代码质量。合理使用这些“注解”,能让JS项目更接近强类型语言的开发体验。

标签:# react  # javascript  # java  # js  # typescript  # 工具  # 代码可读性  
在线客服
服务热线

服务热线

4008888355

微信咨询
二维码
返回顶部
×二维码

截屏,微信识别二维码

打开微信

微信号已复制,请打开微信添加咨询详情!