讲师中心 微信公众号

工具推荐

视频效率加速
剧云
剧云

中文短剧剧本制作平台

Laper
Laper

剧本策划到成片协作

立刻MV
立刻MV

低成本歌曲 MV、视频生成

Seko
Seko

AI短剧一键生成成片

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

星杰大大_6273

星杰大大_6273

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

|

640人浏览过

|

来源于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;
  }
}

⚠️ 注意事项:

Expanso yaml-to-json
Expanso yaml-to-json

使用 Expanso Edge 管道将 YAML 输入转换为 JSON 格式。

下载
  • 移除 @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工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

码上飞
码上飞 Hot

一款基于自然语言的AI应用开发平台,可根据用户描述自动生成应用程序,帮助个人和团队快速完成应用原型与开发。

相关专题

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

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

332

2026.02.13

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

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

540

2026.02.25

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

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

411

2026.03.13

TypeScript 全栈开发进阶指南
TypeScript 全栈开发进阶指南

面向有 JavaScript 基础的开发者,深入讲解 TypeScript 的类型系统与全栈开发实践。

326

2026.06.03

TypeScript Node.js 全栈工程化与Monorepo架构实践
TypeScript Node.js 全栈工程化与Monorepo架构实践

本专题围绕 TypeScript 在 Node.js 全栈开发中的工程化实践展开,系统讲解 Monorepo 架构设计、包管理策略、模块复用机制以及服务端与前端统一类型系统的构建方法。通过真实项目案例,帮助开发者提升大型全栈项目的可维护性与协作效率。

738

2026.06.16

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

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

4496

2024.01.03

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

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

326

2025.12.06

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

40

2026.11.06

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

20

2026.11.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.5万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.8万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn