首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

VSCode中的JSDoc注释折叠

JSDoc注释折叠是指在VSCode编辑器中使用JSDoc注释时,可以通过折叠功能将注释块进行隐藏,以便更好地组织和浏览代码。

JSDoc是一种用于JavaScript代码文档化的标准,通过在代码中添加特定格式的注释,可以生成详细的代码文档。在VSCode中,可以使用JSDoc注释来描述函数、类、变量等的用途、参数、返回值等信息。

折叠JSDoc注释可以提高代码的可读性和可维护性。当注释块过长或包含大量详细信息时,可以将其折叠起来,只显示摘要信息,以便在阅读代码时不被过多的注释干扰。同时,折叠功能还可以帮助快速导航和定位代码,提高开发效率。

在VSCode中,可以通过以下步骤折叠JSDoc注释:

  1. 将光标放置在JSDoc注释的起始行上。
  2. 使用快捷键 Ctrl + Shift + ](Windows/Linux)或 Command + Shift + ](Mac)折叠注释块。
  3. 注释块将被折叠为一行摘要,只显示注释的第一行内容和摘要信息。
  4. 若要展开折叠的注释块,可以使用快捷键 Ctrl + Shift + [(Windows/Linux)或 Command + Shift + [(Mac)。

JSDoc注释折叠可以提高代码的可读性和可维护性,特别适用于大型项目或包含大量注释的代码文件。通过合理使用JSDoc注释折叠,开发人员可以更好地组织和浏览代码,提高开发效率。

腾讯云相关产品中与JSDoc注释折叠相关的功能暂无具体推荐。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

vscode学习笔记

超级强大的 Markdown 插件 Document This:输入/**,生成注释(不安装的情况下,默认会有jsdoc的注释生成) compareit:文件对比 minapp:小程序必备 Local...下 跳转页尾 cmd + - 折叠区域代码 cmd + = 展开区域代码 cmd + alt + - 折叠所有区域代码 cmd + akt + = 展开所有区域代码 cmd + / 添加行注释 Ctrl...+ shift + / 删除行注释 alt +Ctrl + L 选中变量后生成打印变量值的console.log(需安装插件) alt + shift + C 注释所有生成的log alt + shift...+ U 放开所有注释的log alt + shift + D 删除所有生成的log cmd + L 跳转行 cmd + F 查询 cmd + H 替换 cmd + shift + H 所有文件中替换...F3 / Shift + F3 查询上一个/下一个 Alt + Enter 选中所有出现在查询中的 cmd + shift+L 匹配当前选中的词汇或者行,再次选中-可操作 Alt + Click 插入光标

1.2K20

为你的 JavaScript 项目添加智能提示和类型检查

基于 JSDoc JSDoc 是目前最通用的 JavaScript API 文档生成器,根据其语法编写代码注释,可以十分方便地自动生成文档。...VSCode 基本支持 JSDoc 的常见语法,具体使用可参见JSDoc support in JavaScript。...不严格地来说,ts 类型声明文件就像用 TypeScript 语法将 JSDoc 的注释重写了一遍并提取到了单独的文件中。...VSCode 更是将二者作了融合,当你二者混用的时候,可以直接在 JSDoc 的注释中直接使用 ts 类型声明文件中定义的 interface 和 class 等。...另外,在 VSCode 中,类型检查并非默认开启,这意味着即使你有详尽的 JSDoc 注释或 ts 类型声明文件,依然可能在数据类型上栽跟头。

3.6K20
  • TS in JS 实践指北

    JS 里的 TS 不知道大家有没有想过,为什么在 JS 中打出document.的时候,VSCode 就会自动弹出它里面的方法。 ?...神奇的注释 说到在 JS 当中的注释,大家马上会想到 //、 /* */ 然而在这里我将要介绍的是这种注释 /** */ ,也就是 JSDoc 规范的注释。.../** 我是 JSDoc 注释 */ function foo () {} JSDoc JSDoc 是一种注释规范,也是一种生成文档的工具,大家或多或少都接触过。...我们在代码中写一个function的时候,为了下一个接坑的同学不会来找你的麻烦,通常会去注释一下。...改用 JSDoc 去注释代码: 我们经常会习惯性使用//去注释代码,但是如果还需要 IDE 提示的话,我们可以改为 JSDoc 的注释风格。

    4.5K20

    使用JSDoc提高代码的可读性

    首先,JSDoc 并不会对源码产生任何的影响,所有的内容都是写在注释里边的。 所以并不需要担心 JSDoc 会对你的程序造成什么负面影响。...就像是现在超市结账时,没有柜员会以能够记忆N多商品价格而感到骄傲,扫码枪能做到的事情,为什么要占用你的大脑呢。 基础用法 如上文所说的,JSDoc 是写在注释中的一些特定格式内容。...})} */ // 一个包涵参数和返回值的函数 /** @type {function(number, string): boolean} */ 在 vscode 中键入以上的注释,都可以很方便的得到动态提示...不过这个只能应用在@param中,而且复用性并不高,如果有好几处同样结构的定义,那我们就需要把这样的注释拷贝多份,显然不是一个优雅的写法。...能够在一定程度上降低维护成本,尤其是使用 vscode 以后,要手动编写的注释实际上是没有多少的。

    1.4K20

    JSDoc 真能取代 TypeScript?

    我们总得先了解下 JSDoc: 可能大家认为的 JSDoc 是这个东西: 在代码的注释上加上类型的标识,然后通过 jsdoc 命令行工具,就可以直接生成文档。...比如这样的文档: 确实,这个是 JSDoc 最初的含义。 但我们说的 JSDoc 并不是这个,而是 TS 基于 JSDoc 语法实现的,在注释里给代码添加类型的语法。...比如一个 JS 的配置文件,你想在写配置的时候能有提示,就可以用 JSDoc: 这里注释里的 @type 就是 JSDoc 声明类型的语法。...但是用 JSDoc 的方式,不用编译就可以直接调试。 估计是遇到了啥 VSCode 调试上的问题。...然后下面还有个 VSCode 调试器的维护者评论说,有任何调试相关的问题可以找我: 总之,svelte 选择从 ts 转成 JSDoc + dts 并不是因为 ts 有啥问题,主要是为了调试方便。

    42430

    vscode html注释快捷键_VSCode 的快捷键及常用插件总结

    大家好,又见面了,我是你们的朋友全栈君。...1、注释: · 单行注释:ctrl+/, 注释后再按取消 · 取消单行注释:alt+shift+A 注释后再按取消 2、移动行 · 向上移动一行:alt+up · 向下移动一行:alt+down 3、显示...使用 vs code 来打断点调试 14、Document this Js 的注释模板 15、jQuery Code Snippets jquery 提示工具 16、Html2jade html 模板转...26、Stylelint css/sass 代码审查 27、Typings auto installer 安装 vscode 的代码提示依赖库,基于 typtings 的 28、View In Browser...默认浏览器查看HTML文件(快捷键Ctrl+F1可以修改) 29、Vscode-icons 让 vscode 资源目录加上图标、必备 30、VueHelper Vue2代码段(包括Vue2 api、vue-router2

    1.9K30

    Java中的注释

    单行注释 写法: //此行后面均是注释内容 例如://我是一行注释|´・ω・)ノ 多行注释 写法: /* 我是注释内容1 我是注释内容2 */ 单/多行注释的作用: 增强代码的可读性 文档注释...写法: /** *我是文档注释内容 */ 文档注释的作用: 注释允许你在程序中嵌入关于程序的信息。...你可以使用 javadoc 工具软件来生成信息,并输出到HTML文件中。 说明注释,使你更加方便的记录你的程序信息。...javadoc标签 在开始的 /** 之后,第一行或几行是关于类、变量和方法的主要描述。 之后,你可以包含一个或多个各种各样的 @ 标签。...每一个 @ 标签必须在一个新行的开始或者在一行的开始紧跟星号(*). 多个相同类型的标签应该放成一组。例如,如果你有三个 @see 标签,可以将它们一个接一个的放在一起。 示例:

    1.4K20

    VScode 的 JS 智能提示弱爆了?但是我有办法!

    本文针对使用IDE中智能提示功能的介绍,不涉及具体的IDE对代码分析(代码感知)的实现机制的解析,所以因为被标题吸引过来的大佬们抱歉,同时给vscode或者JetBrains写插件(拓展)的大佬们致敬。...同时粘一下大佬们的阵地:微软公开的vscode的github源码 https://github.com/microsoft/vscode 同时本文不涉及aiXcoder、Deep TabNine这类不单针对本地代码进行感知...02 IDE中的智能提示是啥? VScode的效果(没有加JSdoc) ? 代码是用严格模式来写的js游戏项目(如果读者们有需要,有机会会拿出来分享的)。...04 WebStorm一些常用的功能设置 1、快速给文件、方法、字段添加注释 ? 2、鼠标放到字段名或者方法名上时显示这些注释 ? 3、忽略不需要显示的文件类型与文件夹 ?...VScode+JSDoc+d.ts配置会比装WebStorm麻烦,同时提示起来也没有WebStorm体验好 3、WebStorm开发CocosCreator项目,只要把creator.d.ts文件放到项目中

    5.9K30

    Angular 工具篇之文档管理

    Angular 工具篇系列教程目录: Angular 工具篇之规范化Git版本管理 Angular 工具篇之VSCode调试 Angular 工具篇之Storybook Angular 工具篇之国际化处理...支持快速检索,基于强大的 lunr.js 搜索引擎。 支持 JSDoc 高亮,支持 @param, @returns, @link, @ignore 和 @example 标签。...文档注释 comments Compodoc 使用 TypeScript AST 解析器和它的内部 API,因此注释必须是合法的 JSDoc 注释。...有效的注释 /** * Supported comment */ 无效的注释 /* * unsupported comment */ /* unsupported comment */...JSDoc Tags 由于 TypeScript 编译器的限制 目前 Compodoc 只支持以下的 JSDoc 标签: @returns —— 描述返回值 @ignore —— 表示标记的内容永远不会出现在文档中

    1.6K10

    shell中批量注释和取消注释的方法

    ,除了正常的做法,每行前面加#进行注释外 一、手动添加注释 我们还可以用个取巧的办法,也可以写成下面这种 #!...还可以将1-4的输入重定向追加到黑洞中 #!...1.块选择模式 插入注释 首先用vim打开我们要操作的脚本, 然后将光标移动到我们要操作的首行(这里我们移动到echo "1"的左方),接着按v进入-- 可视(visual) --模式 ?...取消注释 ctrl + v 进入块选择模式,选中你要删除的行首的注释符号,注意// 要选中两个, ?...选好之后按d即可删除注释 方法二 替换命令 批量注释: 使用下面命令在指定的行首添加注释: :起始行号,结束行号s/^/注释符/g 我们这里是要操作第2行到第5行,所以用vim打开脚本后,输入

    4.7K40

    如何查看jsplumb.js的API文档(YUIdoc的基本使用)

    最近向一些同事推荐了网页中实现流程图绘制的工具库jsplumb.js,Community版本是开源的,在github的官方仓库的Wiki中能够找到社区版的官方指南,非常非常详细。...jsdoc风格的注释语句转换成静态网站式的离线文档,所以你可以通过定制模板来为最终生成的文档增加不同的主题样式。...jsdoc风格通常都会有IDE插件直接生成(vscode和sublime里肯定是有的,因为我自己天天用),最常见的是函数声明注释,YUIdoc中可以识别的所有语法可以查看官方提供的【YUIdoc支持的注释语法...】: //jsdoc风格的注释 /** * My method description....如果你开发的是一个工具库,需要生成完备的API文档,为了不影响源码阅读和开发,可以像jsplumb.js那样将注释语句单独写在一个文件中,因为是一个自动化工具,也没什么太多可讲的,有需要的朋友直接浏览一下官网就可以很容易地使用了

    2.1K00

    【译】不是 TypeScript 的 TypeScript -- JSDoc 的超能力

    TypeScript的编译器(tsc)以及 VSCode 等编辑器中的语言支持无需任何编译步骤,就能提供出色的开发体验。下面我们来看看如何使用。...目录 带有JSDoc注释的TypeScript 激活检查 内联类型 定义对象 定义函数 导入类型 使用泛型 枚举 typeof 从类扩展 带有 JSDoc 注释的 TypeScript 在最优的情况下,...类型有很多很多,比评论中的几种基本类型更多。结果就是使用 JSDoc 类型可以让你走得很远。...定义对象 除了基本类型,在 JavaScript 中还经常使用到复杂类型和对象,这种情况对基于注释的类型注释也没有问题: /** * @param {[{ price: number, vat: number...写在最后 纯 JavaScript 中增加 TypeScript 注释可以更好地维护项目。

    3.2K30
    领券