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 中开启:

亿众购物系统
亿众购物系统

一套设计完善、高效的web商城解决方案,独有SQL注入防范、对非法操作者锁定IP及记录功能,完整详细的记录了非法操作情况,管理员可以随时查看网站安全日志以及解除系统自动锁定的IP等前台简介:  1)系统为会员制购物,无限会员级别。  2)会员自动升级、相应级别所享有的折扣不同。  3)产品可在缺货时自动隐藏。  4)自动统计所有分类中商品数量,并在商品分类后面显示。  5)邮件列表功能,可在线订阅

下载
{
  "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;
}

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';

const MyAnnotation = (data: string) => { return Reflect.metadata('myannotation', data); };

@MyAnnotation('这是自定义注解数据') class MyClass {}

const metadata = Reflect.getMetadata('myannotation', MyClass); console.log(metadata); // 输出: 这是自定义注解数据

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

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

相关专题

更多
java
java

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

825

2023.06.15

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

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

724

2023.07.05

java自学难吗
java自学难吗

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

731

2023.07.31

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

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

396

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基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

445

2023.08.02

java有什么用
java有什么用

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

429

2023.08.02

java在线网站
java在线网站

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

16881

2023.08.03

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

65

2025.12.31

热门下载

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

精品课程

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

共48课时 | 6.4万人学习

Django 教程
Django 教程

共28课时 | 2.6万人学习

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

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