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

BlessAI
BlessAI

Bless AI 提供五个独特的功能:每日问候、庆祝问候、祝福、祷告和名言的文本生成和图片生成。

下载

工具与框架专用注解

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

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

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

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

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

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

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

832

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

737

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

734

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

397

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

398

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

446

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

430

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

16925

2023.08.03

Java 桌面应用开发(JavaFX 实战)
Java 桌面应用开发(JavaFX 实战)

本专题系统讲解 Java 在桌面应用开发领域的实战应用,重点围绕 JavaFX 框架,涵盖界面布局、控件使用、事件处理、FXML、样式美化(CSS)、多线程与UI响应优化,以及桌面应用的打包与发布。通过完整示例项目,帮助学习者掌握 使用 Java 构建现代化、跨平台桌面应用程序的核心能力。

36

2026.01.14

热门下载

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

精品课程

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

共48课时 | 7.1万人学习

Django 教程
Django 教程

共28课时 | 3.1万人学习

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

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