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

⚠️ 注意事项:

Voicenotes
Voicenotes

Voicenotes是一款简单直观的多功能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

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

469

2024.01.03

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

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

13

2025.12.06

php中文乱码如何解决
php中文乱码如何解决

本文整理了php中文乱码如何解决及解决方法,阅读节专题下面的文章了解更多详细内容。

1

2026.01.28

Java 消息队列与异步架构实战
Java 消息队列与异步架构实战

本专题系统讲解 Java 在消息队列与异步系统架构中的核心应用,涵盖消息队列基本原理、Kafka 与 RabbitMQ 的使用场景对比、生产者与消费者模型、消息可靠性与顺序性保障、重复消费与幂等处理,以及在高并发系统中的异步解耦设计。通过实战案例,帮助学习者掌握 使用 Java 构建高吞吐、高可靠异步消息系统的完整思路。

1

2026.01.28

Python 自然语言处理(NLP)基础与实战
Python 自然语言处理(NLP)基础与实战

本专题系统讲解 Python 在自然语言处理(NLP)领域的基础方法与实战应用,涵盖文本预处理(分词、去停用词)、词性标注、命名实体识别、关键词提取、情感分析,以及常用 NLP 库(NLTK、spaCy)的核心用法。通过真实文本案例,帮助学习者掌握 使用 Python 进行文本分析与语言数据处理的完整流程,适用于内容分析、舆情监测与智能文本应用场景。

23

2026.01.27

拼多多赚钱的5种方法 拼多多赚钱的5种方法
拼多多赚钱的5种方法 拼多多赚钱的5种方法

在拼多多上赚钱主要可以通过无货源模式一件代发、精细化运营特色店铺、参与官方高流量活动、利用拼团机制社交裂变,以及成为多多进宝推广员这5种方法实现。核心策略在于通过低成本、高效率的供应链管理与营销,利用平台社交电商红利实现盈利。

120

2026.01.26

edge浏览器怎样设置主页 edge浏览器自定义设置教程
edge浏览器怎样设置主页 edge浏览器自定义设置教程

在Edge浏览器中设置主页,请依次点击右上角“...”图标 > 设置 > 开始、主页和新建标签页。在“Microsoft Edge 启动时”选择“打开以下页面”,点击“添加新页面”并输入网址。若要使用主页按钮,需在“外观”设置中开启“显示主页按钮”并设定网址。

51

2026.01.26

苹果官方查询网站 苹果手机正品激活查询入口
苹果官方查询网站 苹果手机正品激活查询入口

苹果官方查询网站主要通过 checkcoverage.apple.com/cn/zh/ 进行,可用于查询序列号(SN)对应的保修状态、激活日期及技术支持服务。此外,查找丢失设备请使用 iCloud.com/find,购买信息与物流可访问 Apple (中国大陆) 订单状态页面。

192

2026.01.26

npd人格什么意思 npd人格有什么特征
npd人格什么意思 npd人格有什么特征

NPD(Narcissistic Personality Disorder)即自恋型人格障碍,是一种心理健康问题,特点是极度夸大自我重要性、需要过度赞美与关注,同时极度缺乏共情能力,背后常掩藏着低自尊和不安全感,影响人际关系、工作和生活,通常在青少年时期开始显现,需由专业人士诊断。

7

2026.01.26

热门下载

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

精品课程

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

共58课时 | 4.2万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 2.5万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3万人学习

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

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