0

0

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

星夢妙者

星夢妙者

发布时间:2025-11-18 17:18:56

|

925人浏览过

|

来源于php中文网

原创

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

天工大模型
天工大模型

中国首个对标ChatGPT的双千亿级大语言模型

下载

工具与框架专用注解

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

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

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

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

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

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

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

47

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

194

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

1

2026.03.13

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1031

2023.08.02

typedef和define区别
typedef和define区别

typedef和define区别在类型检查、作用范围、可读性、错误处理和内存占用等。本专题为大家提供typedef和define相关的文章、下载、课程内容,供大家免费下载体验。

119

2023.09.26

c语言typedef的用法
c语言typedef的用法

c语言typedef的用法有定义基本类型别名、定义结构体别名、定义指针类型别名、定义枚举类型别名、定义数组类型别名等。本专题为大家提供typedef相关的文章、下载、课程内容,供大家免费下载体验。

105

2023.09.26

class在c语言中的意思
class在c语言中的意思

在C语言中,"class" 是一个关键字,用于定义一个类。想了解更多class的相关内容,可以阅读本专题下面的文章。

891

2024.01.03

python中class的含义
python中class的含义

本专题整合了python中class的相关内容,阅读专题下面的文章了解更多详细内容。

32

2025.12.06

Python异步编程与Asyncio高并发应用实践
Python异步编程与Asyncio高并发应用实践

本专题围绕 Python 异步编程模型展开,深入讲解 Asyncio 框架的核心原理与应用实践。内容包括事件循环机制、协程任务调度、异步 IO 处理以及并发任务管理策略。通过构建高并发网络请求与异步数据处理案例,帮助开发者掌握 Python 在高并发场景中的高效开发方法,并提升系统资源利用率与整体运行性能。

37

2026.03.12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React 教程
React 教程

共58课时 | 6万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1万人学习

React核心原理新老生命周期精讲
React核心原理新老生命周期精讲

共12课时 | 1.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

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