0

0

JS注解怎么标注继承关系_ JS类继承关系的注解书写与使用

雪夜

雪夜

发布时间:2025-11-16 21:21:26

|

309人浏览过

|

来源于php中文网

原创

使用 @extends 标注类继承关系,如 @extends {Animal},可提升JavaScript代码的可读性和IDE支持,结合 @class 和 @abstract 能更清晰表达类结构,尤其在启用 // @ts-check 时增强类型检查。

js注解怎么标注继承关系_ js类继承关系的注解书写与使用

在JavaScript中,虽然没有像Java那样的正式注解(Annotation)语法,但在使用JSDoc这样的文档工具时,可以通过特定的标签来标注类之间的继承关系,帮助开发者理解代码结构、提升IDE智能提示的准确性。特别是在使用ES6+的class语法时,正确书写JSDoc注解对维护大型项目非常有帮助。

使用 @extends 或 @extends 标注继承关系

在JSDoc中,标注一个类继承自另一个类,应使用 @extends(或等价的 @augments)标签。

语法格式如下:

/** * @extends {父类名称} */

示例:

/** * 动物基类 */ class Animal { constructor(name) { this.name = name; }

speak() {
console.log(${this.name} 发出声音。);
}
}

/**

  • 狗类,继承自动物
  • @extends {Animal}
    */
    class Dog extends Animal {
    constructor(name, breed) {
    super(name);
    this.breed = breed;
    }

bark() {
console.log(${this.name} 汪汪叫!);
}
}

通过 @extends {Animal},IDE(如VS Code、WebStorm)就能识别 Dog 类拥有 Animal 的所有方法和属性,并提供自动补全和类型检查支持。

结合 @class 和 @abstract 使用更清晰

为了增强文档可读性,可以配合其他JSDoc标签:

BlessAI
BlessAI

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

下载
  • @class:显式声明这是一个类。
  • @abstract:表示该类是抽象类,不应被直接实例化。

示例:

/** * 抽象形状类 * @class * @abstract */ class Shape { getArea() { throw new Error('子类必须实现 getArea 方法'); } }

/**

  • 矩形类
  • @extends {Shape}
  • @class
    */
    class Rectangle extends Shape {
    constructor(width, height) {
    super();
    this.width = width;
    this.height = height;
    }

getArea() {
return this.width * this.height;
}
}

在 TypeScript 中的差异

如果你使用的是TypeScript,则不需要依赖JSDoc来表达继承关系,因为继承在类型系统中是显式的。但若你在纯JS文件中使用TypeScript的类型检查(如通过 // @ts-check),正确的JSDoc注解就尤为重要。

例如,在启用 // @ts-check 的JS文件中:

// @ts-check

/* @extends {Animal} / class Cat extends Animal { constructor(name) { super(name); }

// IDE会提示 speak() 已从 Animal 继承 meow() { this.speak(); // 正确调用父类方法 } }

此时,TypeScript会基于JSDoc进行类型推断,确保调用合法。

常见注意事项

  • 大括号不能省略@extends Animal 写法不规范,应写作 @extends {Animal},否则可能无法被解析。
  • 确保父类已定义或导入:如果父类在另一个模块中,建议使用 import() 语法说明类型来源,如 @extends {import('./Animal').Animal}
  • IDE支持程度不同:VS Code对JSDoc支持良好,但某些旧编辑器可能忽略这些注解。

基本上就这些。正确使用 @extends 注解,能显著提升JavaScript项目的可维护性和开发体验,尤其是在没有强类型语言环境的情况下。

相关专题

更多
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号