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

从jsDoc输出中排除外部变量

是指在使用jsDoc生成文档时,排除掉不需要包含在文档中的外部变量。这可以通过在jsDoc注释中使用特定的标记来实现。

在jsDoc注释中,可以使用@ignore标记来排除特定的变量。例如,如果要排除名为externalVariable的外部变量,可以在注释中添加@ignore标记:

代码语言:txt
复制
/**
 * @ignore
 */
var externalVariable;

这样,在生成文档时,externalVariable将被排除在外,不会包含在文档中。

另外,如果要排除整个外部模块或文件中的变量,可以使用@module@file标记,并将其设置为@ignore。例如:

代码语言:txt
复制
/**
 * @module
 * @ignore
 */

这将排除整个模块或文件中的所有变量。

需要注意的是,具体的jsDoc语法和标记可能因不同的工具和版本而有所差异。因此,在使用特定工具生成文档时,建议查阅该工具的文档以了解更详细的用法和配置选项。

对于腾讯云相关产品和产品介绍链接地址,可以参考腾讯云官方文档或开发者社区,以获取与云计算相关的产品信息和推荐链接。

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

相关·内容

检查JavaScript文件_TypeScript笔记18

function sayHello(somebody = 'John Doe') { console.log('Hello ' + somebody); } // 正确 sayHello(); ...没有提供用来表示泛型参数的语法,因此未指定的类型参数都默认any类型 泛型在 JavaScript 中主要以 2 种形式出现: 继承泛型类,创建 Promise 等(泛型类、Promise 等定义在外部...= new Promise((resolve, reject) => { reject(false) }); // p 类型为 Promise p; 除了这种来自外部声明...定义的泛型,若未指定类型参数,就默认any 类型宽松的对象字面量 .ts里,用对象字面量初始化变量的同时会确定该变量的类型,并且不允许往对象字面量上添加新成员,例如: // .ts // obj 类型为...this.constructorOnly = false; this.constructorUnknown = "plunkbat"; } null、undefined、[]赋值推断 .js里,初始值为null、undefined的变量

2.4K50

JavaScript 重构攻略

变量和方法控制: 模块开发不允许存放独立的全局变量、全局方法,只允许把变量和方法放置到相应模块的 “命名空间” 中。实在心痒了,那么使用匿名函数如何?...数据存放约束: 普通变量、prototype 变量和 function 变量分而治之,方法名一律大写开头,变量名还是遵从骆驼命名法如何: function T(name){ T.prototype...下载 jsdoc-tookit(http://code.google.com/p/jsdoc-toolkit/)和 jsdoc-tookit-ant-task(http://code.google.com...5、关联常量预置模块,这部分主要是一些系统常量无法在 JavaScript 中确定下来,需要外部传值进去。...: 比如语言文字右向左排列和左向右排列是造成某些展示不同的根本原因,那么在关联常量预置模块中设置好语种,涉及到的语种和左右排列方向的对应关系应当存放在代码中,最后在 JavaScript 代码中区分对待就可以了

1.8K20

JSDoc 真能取代 TypeScript?

我们总得先了解下 JSDoc: 可能大家认为的 JSDoc 是这个东西: 在代码的注释上加上类型的标识,然后通过 jsdoc 命令行工具,就可以直接生成文档。...那肯定不止这么点语法,我们再看几个: 比如可以用 @type 给变量声明类型: 这里可以是各种类型,比如函数类型: 如果类型被多处用到,可以用 @typedef 抽出来,单独命名: 你还可以把这个类型放到...这就是 JSDoc 定义 class 类型的方式。 综上,用 JSDoc 可以定义变量、函数、class、泛型等,可以别的 dts 文件引入类型。 基本上 ts 能做的,JSDoc 也都可以。...然后下面还有个 VSCode 调试器的维护者评论说,有任何调试相关的问题可以找我: 总之,svelte 选择 ts 转成 JSDoc + dts 并不是因为 ts 有啥问题,主要是为了调试方便。...ts 里可以定义的类型,在 JSDoc 里都可以定义,比如变量、函数、class、泛型,甚至类型编程等。复杂的类型还可以抽离到 dts 里,在 @type 里引入。

32130

Angular 工具篇之文档管理

支持 JSDoc 高亮,支持 @param, @returns, @link, @ignore 和 @example 标签。 支持文档覆盖率统计。...-d, –output [folder] —— 指定文档的输出目录 -h, –help —— 显示帮助信息 若需查看完整的配置项,可以浏览 compodoc - usage。...文档注释 comments Compodoc 使用 TypeScript AST 解析器和它的内部 API,因此注释必须是合法的 JSDoc 注释。...JSDoc Tags 由于 TypeScript 编译器的限制 目前 Compodoc 只支持以下的 JSDoc 标签: @returns —— 描述返回值 @ignore —— 表示标记的内容永远不会出现在文档中...@param —— 定义一个参数的类型和描述 @link —— 定义链接另一个方法、文档或外部链接 @example —— 定义一个示例用法 了解完上述标签,我们来看一个比较完整的示例(来源于 ionic-code-documentation

1.6K10

TS in JS 实践指北

比如定义一个变量,下一行使用它的时候,VSCode 会知道这个变量哪来的。 但是在自定义的函数里面,IDE 不知道传参的类型,因此这些函数里的入参缺失了 type,成了 any。...因此建议只对使用频率高的对象加上额外的 JSDoc 注释,比如zepto、全局变量、接口数据等。 有时我们在使用某个库的时候。.../InterfaceJs.d').INewObj } // 手动引入外部的 .d.ts 声明文件 */ var newObj = someRequireFn('....vue type 这里我们另一个角度来考察它,不依靠插件能力,不多修改代码本身,并能使用官方提供的 TS 能力。 注:以下内容包含了泛型知识点,只需要应用的同学可以直接拉到结论部分。...怎么去应用 1.对公共组件和全局变量编写声明文件2.对自定义的函数编写 JSDoc 注释,并优雅的完善它3.对作用域不清晰的的变量、对象等使用 JSDoc 的@type,去指定它的类型 注意事项 1.不要瞎用

4.4K20

使用JSDoc提高代码的可读性

众所周知, JavaScript 是一个弱类型的脚本语言,这就意味着,编辑器中并不能直观的看出这段代码的作用是什么,有些事情只有等到代码真正的运行起来才能够确定。...那么他可能会有这么几个疑问: getUserInfo的返回值是什么结构 createOrder的返回值又是什么结构 notify中传入的两个变量又都是用来做什么的 我们也只能够notify函数中找到一些线索...实际上@type的使用频率相较于其他两个是很低的,因为大多数情况下@type用于标识变量的类型。 而变量的来源基本上只有两个 1. 基本类型赋值 2....必然会存在着大量的复杂结构类型的变量、参数或返回值。 关于函数参数,在 JSDoc 中两种方式可以描述复杂类型: ?...上边介绍的只是 JSDoc 常用的几个标记,实际上还有更多的功能没有提到,具体的文档地址:jsdoc 参考资料 jsdoc | @return jsdoc | @param jsdoc | @typedef

1.4K20

Ant+JSDocTookit生成Javascript文档

/docs" encoding="utf-8"> 如果有中文指定输入/输出文件的编码encoding="utf-8" jsdoc的模板文件就是HTML+CSS,所以可以修改成你想要的样子,也可以装上第三方的模板...,见http://code.google.com/p/jsdoc-toolkit/wiki/TemplateGallery jsdoctoolkit ant task的详细属性 关于JSDoc的简单用法...YUI Doc和JavaDoc、JSDocJsDoc Toolkit相似。YUI Doc是由注解驱动(comment-driven )的系统,它通过解析代码中描述结构的注解来生成文档。...为了使用方便需要配置一下“环境变量”,即在“我的电脑 》右键 》属性 》高级 》环境变量 》系统变量 》 选中Path 》 编辑”,在弹出框中加入: ;D:\Program Files\python...开始 》运行 》(Win + R)输入“cmd”,输入: python -c "import pkg_resources" 没有任何输出,即表示setuptools安装成功。

85730

JSDoc还需要TypeScript吗

JavaScript开始,直到你想起写代码时没有类型是多么痛苦。所以你把文件.js重命名为.ts。然后意识到你已经打开了一个麻烦的玩意儿。...当你的TypeScript被执行时,所有的类型信息都会完全丢失(这就是为什么你不写一个类型守卫,就不能测试一个变量是否是某个类型的原因)。...当你把TypeScript编译成JavaScript时,它基本上只是你的代码中删除了所有的类型信息,所以它又变成了有效的JavaScript代码。...JSDoc 在JavaScript诞生25年多后,JSDoc作为一种注释JavaScript代码的方式被引入。它是一种正式的标记语言,允许IDE在开发者看到一个函数时提供额外的上下文。...string; age: number }} */ let person /** @type {(s: string, b: boolean) => void} */ let myCallback *

28220

C++ 程序员的 Java 指南

整数整数可能导致零异常,而浮点数不会。 break 和 continue 能够使用 flag 来跳出和继续指定循环。...初始化块和声明属性时指定初始值,这些按源程序中排列顺序执行。 java 中只有值传递。...内部类里引用外部类的属性或者方法时,可以用命 OuterClass.this.。 非静态内部类里不能有静态成员。 内部类可以使用 static 修饰,外部类不行。...外部类外创建内部非静态类的语法:OuterClass.InnerClass varName = OuterInstance.new InnerConstructor(); 外部类外创建内部静态类的语法...纠误一处:《疯狂 Java 讲义》P214 讲道「如果匿名内部类需要访问外部类的局部变量,则必须使用 final 修饰符来修饰外部类的局部变量,否则系统将报错。

58810

C++ 程序员的 Java 指南

整数整数可能导致零异常,而浮点数不会。 break 和 continue 能够使用 flag 来跳出和继续指定循环。...初始化块和声明属性时指定初始值,这些按源程序中排列顺序执行。 java 中只有值传递。...内部类里引用外部类的属性或者方法时,可以用命 OuterClass.this.。 非静态内部类里不能有静态成员。 内部类可以使用 static 修饰,外部类不行。...外部类外创建内部非静态类的语法:OuterClass.InnerClass varName = OuterInstance.new InnerConstructor(); 外部类外创建内部静态类的语法...纠误一处:《疯狂 Java 讲义》P214 讲道「如果匿名内部类需要访问外部类的局部变量,则必须使用 final 修饰符来修饰外部类的局部变量,否则系统将报错。

41830

【Go语言刷题篇】Go0到入门1:输出变量、常量、字符串、指针与值的简单案例

Q1:输出入门 题目要求:输出打印"Hello World!"...} Q2:定义变量输出变量 题目要求:已知小明的信息(姓名:小明,年龄:23,性别:男),定义三个变量,分别表示姓名(string类型),年龄(int类型),性别(男true,女false,bool类型...),然后按照姓名,年龄,性别的顺序,逐行输出对应的信息。...3、Go语言中使用&字符放在变量前面对变量进行“取地址”操作。...回文数是指正序(左向右)和倒序(右向左)读都是一样的整数。例如,121 是回文,而 123 不是。 相关知识: 1、整型转化为字符串。 2、字符串的遍历。

6910

@ts-check

七月份在腾讯实习到现在,接触到了不少项目的代码,平均算来每天都有 70% 的时间用于阅读、理解他人的代码。...多亏了 TypeScript和 JSDoc,这两个愿望都有变成现实的可能。...然而对于老项目而言,切换构建往往意味着麻烦和巨大的风险,而且假如将来 JavaScript也引入了类型系统(这非常有可能),那又得 TypeScript切回 JavaScript(回归标准)。...举个例子,在下图中我们首先声明了一个变量 a,然后把数字 1 赋给了它,接着又把字符串 '123' 赋给了它,看起来好像没有什么问题。 ?...JSDoc 添加类型 如果仅仅使用 // [@ts-check](/user/ts-check)的话,我们只能使用它的自动类型推断功能,这对于大型项目来说是远远不够的,我们希望能像强类型语言一样指定每个变量的类型

1.8K80

@ ts-check

七月份在腾讯实习到现在,接触到了不少项目的代码,平均算来每天都有 70% 的时间用于阅读、理解他人的代码。...多亏了 TypeScript和 JSDoc,这两个愿望都有变成现实的可能。...然而对于老项目而言,切换构建往往意味着麻烦和巨大的风险,而且假如将来 JavaScript也引入了类型系统(这非常有可能),那又得 TypeScript切回 JavaScript(回归标准)。...举个例子,在下图中我们首先声明了一个变量 a,然后把数字 1 赋给了它,接着又把字符串 '123' 赋给了它,看起来好像没有什么问题。...JSDoc 添加类型 如果仅仅使用 // @ts-check的话,我们只能使用它的自动类型推断功能,这对于大型项目来说是远远不够的,我们希望能像强类型语言一样指定每个变量的类型。

2.7K10

@ts-check

七月份在腾讯实习到现在,接触到了不少项目的代码,平均算来每天都有 70% 的时间用于阅读、理解他人的代码。...多亏了 TypeScript和 JSDoc,这两个愿望都有变成现实的可能。...然而对于老项目而言,切换构建往往意味着麻烦和巨大的风险,而且假如将来 JavaScript也引入了类型系统(这非常有可能),那又得 TypeScript切回 JavaScript(回归标准)。...举个例子,在下图中我们首先声明了一个变量 a,然后把数字 1 赋给了它,接着又把字符串 '123' 赋给了它,看起来好像没有什么问题。 ?...JSDoc 添加类型 如果仅仅使用 // [@ts-check](/user/ts-check)的话,我们只能使用它的自动类型推断功能,这对于大型项目来说是远远不够的,我们希望能像强类型语言一样指定每个变量的类型

1.1K20

十分钟了解 TypeScript 是如怎样工作的

TypeScript 编译器保存其输出的目录为 dist/。 输出文件的模块格式为 CommonJS。...其他外,此信息使运行时环境能够执行 JavaScript 代码,同时在错误信息中显示 TypeScript 代码的行号。...好处:当 JavaScript 迁移到 TypeScript 时,我们可以先使 JavaScript 和 TypeScript 文件混合存在,然后再慢慢把更多 JavaScript 文件转换为 TypeScript...TypeScript 编译器使用通过 JSDoc 注释指定的静态类型信息(请参见下面的例子)。如果可以的话,我们可以完全静态类型化纯 JavaScript 文件,甚至可以派生它们的声明文件。...这是一个 JSDoc 注释的例子,它为函数 add() 提供静态类型信息: /** * @param {number} x - A number param.

1.3K20
领券