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

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 中开启:
{
"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 注解的效果。根据你的实际需求选择合适的方式。不复杂但容易忽略的是配置和编译支持。










