0

0

VSCode中的JSDoc:让你的JavaScript代码自带文档

P粉986688829

P粉986688829

发布时间:2026-01-06 15:12:45

|

260人浏览过

|

来源于php中文网

原创

JSDoc是VSCode中提升JavaScript协作效率和可维护性的实用工具,需用/* /紧贴函数上方书写,配合规范标签(如@param、@returns)、具体类型声明及jsconfig.json配置,才能激活智能提示、类型检查与自动补全。

vscode中的jsdoc:让你的javascript代码自带文档

在VSCode中写JavaScript时,JSDoc不是装饰,是提升协作效率和代码可维护性的实用工具。它让函数、参数、返回值一目了然,还能触发智能提示、类型检查和自动补全。

写对基础格式,VSCode立刻识别

JSDoc注释必须紧贴函数或变量上方,用/** */包裹,不能是/* *///。VSCode靠这个约定激活文档支持。

  • ✅ 正确:/** @param {string} name */
    function greet(name) { ... }
  • ❌ 错误:/* @param {string} name */
    function greet(name) { ... }
    (VSCode不解析)
  • 光标停在函数名上,悬停就能看到完整文档;调用时参数名、类型、说明自动浮现

常用标签怎么写才真正起作用

VSCode不只看标签名,更依赖语法是否规范。几个高频标签的写法要点:

  • @param:紧跟花括号写类型,空格后写参数名,再换行写说明
    /** @param {number} age 用户年龄,必须大于0 */
  • @returns:类型必填,说明可选
    /** @returns {boolean} 是否成年 */
  • @typedef:定义自定义类型,后续可用在@param@returns
    /** @typedef {{id: number, name: string}} User */
  • @example:加@example后换行缩进写代码,VSCode会在悬停中高亮显示示例

配合TypeScript或JSDoc类型推导,效果翻倍

即使不用TS编译,VSCode也能基于JSDoc做静态分析。关键在于类型声明要具体:

Android中JNI编程的那些事儿 中文WORD版
Android中JNI编程的那些事儿 中文WORD版

本文档主要讲述的是Android中JNI编程的那些事儿;JNI译为Java本地接口。它允许Java代码和其他语言编写的代码进行交互。在android中提供JNI的方式,让Java程序可以调用C语言程序。android中很多Java类都具有native接口,这些接口由本地实现,然后注册到系统中。希望本文档会给有需要的朋友带来帮助;感兴趣的朋友可以过来看看

下载

立即学习Java免费学习笔记(深入)”;

  • {string[]}{Array}更准,能触发数组方法提示
  • 对象类型推荐用{name: string, score?: number},问号表示可选属性
  • 函数类型写成{(id: string): Promise},VSCode会校验调用时的参数和返回
  • 开启"js/ts.implicitProjectConfig.checkJs": true(在settings.json里),让纯.js文件也启用类型检查

别忽略这些小细节,否则提示不出现

写了JSDoc却没提示?常见卡点就这几个:

  • 函数被赋值给变量(如const fn = function() {}),JSDoc必须写在function关键字正上方,而不是变量声明前
  • 箭头函数不支持直接写JSDoc,需改用函数声明,或在变量声明前加注释并标注@type
  • 项目根目录有jsconfig.json(哪怕空文件)才能启用完整JS语言服务
  • 确保VSCode没有禁用JavaScript/TypeScript语言功能(检查设置里"javascript.suggest.autoImports"等是否开启)

基本上就这些。不需要大改代码结构,从下一个函数开始补上几行JSDoc,立刻就能感受到编辑器变得更“懂你”。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

547

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

373

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

730

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

471

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

394

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

990

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

655

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

550

2023.09.20

C++ 高性能计算与并行编程
C++ 高性能计算与并行编程

本专题专注于 C++ 在高性能计算(HPC)与并行编程中的应用,涵盖多线程、并发数据处理、OpenMP、MPI、GPU加速等技术。通过实际案例,帮助开发者掌握 如何利用 C++ 进行大规模数据计算和并行处理,提高程序的执行效率,适应高性能计算与数据密集型应用场景。

1

2026.01.08

热门下载

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

精品课程

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

共58课时 | 3.4万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 2万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.8万人学习

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

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