首页 > web前端 > js教程 > 正文

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

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

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

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:说明函数可能抛出的异常类型。

知我AI·PC客户端
知我AI·PC客户端

离线运行 AI 大模型,构建你的私有个人知识库,对话式提取文件知识,保证个人文件数据安全

知我AI·PC客户端 35
查看详情 知我AI·PC客户端

工具与框架专用注解

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

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

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

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

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

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

以上就是JS注解有哪些类型_ JS中常见的注解类型及其功能解析的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号