0

0

JSDoc 注释应放在 JavaScript 类的构造函数上方,而非类声明上方

花韻仙語

花韻仙語

发布时间:2026-01-28 18:16:05

|

560人浏览过

|

来源于php中文网

原创

JSDoc 注释应放在 JavaScript 类的构造函数上方,而非类声明上方

jsdoc 注释应紧贴 `constructor` 方法上方,才能正确为参数(如 `radius`)提供类型提示和悬停文档;类级别的 jsdoc 仅描述类本身,无法关联构造参数。

在 JavaScript 中使用 JSDoc 为 ES2015+ class 添加类型与文档说明时,注释位置至关重要。VS Code 等编辑器依赖 JSDoc 的语义位置来推断类型、生成智能提示(IntelliSense)及悬停文档。若将 JSDoc 写在 class 声明前(如问题中所示),编辑器仅能识别该注释用于描述整个 Circle 类,而不会将其参数(@param radius)绑定到构造函数签名上——因此悬停 radius 时无提示。

✅ 正确做法:将 JSDoc 放在 constructor 方法正上方:

/**
 * Represents a circle and provides methods to calculate its perimeter and area.
 * @see https://en.wikipedia.org/wiki/Circle
 */
export default class Circle {
  /**
   * Creates a new Circle instance.
   * @param {number} radius - The radius of the circle. Must be positive.
   */
  constructor(radius) {
    if (radius <= 0) throw new Error('Radius must be a positive number');
    this.radius = radius;
  }

  perimeter() {
    return this.radius * 2 * Math.PI;
  }

  area() {
    return Math.pow(this.radius, 2) * Math.PI;
  }
}

⚠️ 注意事项:

小微助手
小微助手

微信推出的一款专注于提升桌面效率的助手型AI工具

下载
  • 移除 @constructor 标签:ES2015 class 语法下,JSDoc 可自动识别 constructor 方法,显式添加 @constructor 不但冗余,还可能干扰解析(尤其在某些工具链中);
  • 避免在类注释中写 @param:@param、@returns 等参数/返回值标签必须出现在函数(含 constructor)的 JSDoc 中,否则 JSDoc 解析器无法建立参数与形参的映射;
  • 方法定义建议用普通函数语法:问题中使用了箭头函数赋值(perimeter = () => { ... }),虽可行,但会丢失 this 绑定灵活性,且部分类型工具(如 TypeScript 或 JSDoc + Closure Compiler)对类字段箭头函数的类型推导支持较弱;推荐使用标准方法定义(如 perimeter() { ... })以获得更佳 IDE 支持;
  • 补充运行时校验可提升健壮性:如示例中对 radius 的正数检查,配合 JSDoc 的 @param 描述,形成「文档 + 类型 + 行为」三重保障。

总结:JSDoc 是面向“被注释的代码元素”生效的——类注释描述类,构造函数注释描述构造行为及参数。精准定位注释位置,是解锁现代 JavaScript 工具链(VS Code、TypeScript、ESLint、typedoc 等)智能能力的关键前提。

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

68

2026.03.13

class在c语言中的意思
class在c语言中的意思

在C语言中,"class" 是一个关键字,用于定义一个类。想了解更多class的相关内容,可以阅读本专题下面的文章。

911

2024.01.03

python中class的含义
python中class的含义

本专题整合了python中class的相关内容,阅读专题下面的文章了解更多详细内容。

32

2025.12.06

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

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

49

2026.03.13

Python异步编程与Asyncio高并发应用实践
Python异步编程与Asyncio高并发应用实践

本专题围绕 Python 异步编程模型展开,深入讲解 Asyncio 框架的核心原理与应用实践。内容包括事件循环机制、协程任务调度、异步 IO 处理以及并发任务管理策略。通过构建高并发网络请求与异步数据处理案例,帮助开发者掌握 Python 在高并发场景中的高效开发方法,并提升系统资源利用率与整体运行性能。

88

2026.03.12

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

272

2026.03.11

Go高并发任务调度与Goroutine池化实践
Go高并发任务调度与Goroutine池化实践

本专题围绕 Go 语言在高并发任务处理场景中的实践展开,系统讲解 Goroutine 调度模型、Channel 通信机制以及并发控制策略。内容包括任务队列设计、Goroutine 池化管理、资源限制控制以及并发任务的性能优化方法。通过实际案例演示,帮助开发者构建稳定高效的 Go 并发任务处理系统,提高系统在高负载环境下的处理能力与稳定性。

59

2026.03.10

热门下载

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

精品课程

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

共58课时 | 6.1万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 3.5万人学习

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号