0

0

JS注解怎么定义_ JS注解自定义注解的完整定义方法

雪夜

雪夜

发布时间:2025-11-11 10:08:02

|

727人浏览过

|

来源于php中文网

原创

JavaScript无原生注解,但可通过JSDoc定义文档标签(如@customTag)用于提示,或使用TypeScript装饰器配合experimentalDecorators实现行为修改,还可结合reflect-metadata库在运行时添加元数据,实现类似注解功能。

js注解怎么定义_ js注解自定义注解的完整定义方法

JavaScript 本身并没有“注解”(Annotation)这一语法特性,像 Java 或 TypeScript 中的装饰器(Decorator)那样的注解机制在原生 JS 中并不存在。你提到的“JS注解自定义注解”,可能是对 TypeScript 装饰器JS 文档注释(如 JSDoc) 的误解或混淆。下面分别说明这两种常见场景的“注解”定义方法。

1. 使用 JSDoc 定义自定义注解(文档注释)

JSDoc 是 JavaScript 中用于生成文档和类型提示的注释规范,支持自定义标签。

虽然不能改变代码行为,但可用于 IDE 提示、类型检查(配合 ESLint/TSC)。

定义自定义 JSDoc 标签:

创建一个 jsdoc.conf.json 配置文件:

{
  "tags": {
    "allowUnknownTags": true
  },
  "plugins": [],
  "templates": {
    "default": {
      "includeDate": false
    }
  }
}

在代码中使用自定义标签:

/**
 * @description 计算两个数的和
 * @author 张三
 * @version 1.0.0
 * @customTag 模块A专用
 * @since 2025-04-05
 */
function add(a, b) {
  return a + b;
}

IDE(如 VSCode)或工具(如 WebStorm)会识别这些标签并提供提示。

2. 使用 TypeScript 装饰器模拟“注解”功能

TypeScript 支持装饰器(Decorators),这是一种真正的“注解式”编程,可以修改类、方法、属性等的行为。

启用装饰器:

tsconfig.json 中开启:

意兔-AI漫画相机
意兔-AI漫画相机

照片变漫画手绘,做周边好物

下载
{
  "compilerOptions": {
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true
  }
}

定义自定义装饰器函数:

function Log(target: any, propertyName: string, descriptor: PropertyDescriptor) {
  const originalMethod = descriptor.value;
  descriptor.value = function (...args: any[]) {
    console.log(`调用方法: ${propertyName},参数:`, args);
    const result = originalMethod.apply(this, args);
    console.log(`结果:`, result);
    return result;
  };
  return descriptor;
}
<p>class Calculator {
@Log
add(a: number, b: number): number {
return a + b;
}
}

调用 new Calculator().add(2, 3) 会自动输出日志。

你也可以定义类装饰器、属性装饰器、参数装饰器,实现更复杂的“注解”逻辑。

3. JavaScript 中模拟注解(运行时元数据)

借助第三方库(如 reflect-metadata),可以在 JS/TS 中实现类似注解的元数据操作。

安装:

npm install reflect-metadata

定义自定义“注解”:

import 'reflect-metadata';
<p>const MyAnnotation = (data: string) => {
return Reflect.metadata('myannotation', data);
};</p><p>@MyAnnotation('这是自定义注解数据')
class MyClass {}</p><p>const metadata = Reflect.getMetadata('myannotation', MyClass);
console.log(metadata); // 输出: 这是自定义注解数据

这种方式常用于依赖注入、路由映射等框架设计中。

基本上就这些。JavaScript 没有原生注解,但通过 JSDoc 可以定义文档级“注解”,通过 TypeScript 装饰器 + reflect-metadata 可以实现运行时元数据控制,达到类似 Java 注解的效果。根据你的实际需求选择合适的方式。不复杂但容易忽略的是配置和编译支持。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

49

2026.02.13

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

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

196

2026.02.25

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

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

53

2026.03.13

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

457

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

549

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

337

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

531

2023.06.20

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

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

49

2026.03.13

热门下载

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

精品课程

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

共58课时 | 6.1万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 3.4万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.6万人学习

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

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