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

如何使用JSDoc来记录从外部包继承的类方法?

JSDoc是一种用于JavaScript代码文档化的标记语言,它可以帮助开发者记录和生成代码文档。当我们使用外部包并继承其中的类方法时,可以使用JSDoc来记录这些继承的类方法。

下面是使用JSDoc记录从外部包继承的类方法的步骤:

  1. 首先,确保你的项目中已经安装了JSDoc。你可以通过在终端中运行以下命令来安装JSDoc:
  2. 首先,确保你的项目中已经安装了JSDoc。你可以通过在终端中运行以下命令来安装JSDoc:
  3. 在你的代码文件中,找到继承外部包类的地方。在类的声明之前,使用JSDoc的@extends标签指定继承的类。例如:
  4. 在你的代码文件中,找到继承外部包类的地方。在类的声明之前,使用JSDoc的@extends标签指定继承的类。例如:
  5. 这样,JSDoc就知道MyClass继承自ExternalClass
  6. 在继承的类方法上方使用JSDoc的@inheritdoc标签来继承父类方法的文档。例如:
  7. 在继承的类方法上方使用JSDoc的@inheritdoc标签来继承父类方法的文档。例如:
  8. 这样,JSDoc会自动将父类方法的文档复制到myMethod方法上。
  9. 运行JSDoc命令来生成文档。在终端中,进入你的项目目录,并运行以下命令:
  10. 运行JSDoc命令来生成文档。在终端中,进入你的项目目录,并运行以下命令:
  11. 这将生成一个包含文档的HTML文件。

使用JSDoc记录从外部包继承的类方法可以提供清晰的文档,方便其他开发者理解和使用你的代码。对于JSDoc的更多详细用法和标签,你可以参考腾讯云的JSDoc相关文档:JSDoc - 腾讯云

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

相关·内容

【Kotlin】Kotlin 继承 三 ( super 关键字使用 | super@ 外部调用父方法 | 子类选择性调用 父 接口 方法 super )

继承 / 实现 : 子类继承了父 , 或实现了接口 , 接收了父所有操作与属性 , 2 ....super 关键字进行简单调用即可 ; ② 子类内部类调用父 : 如果想要在子类内部调用父成员和方法 , 需要使用 super@子类名称 调用 ; ③ 子类调用不同父同名方法 : 如果子类继承.../ 实现接口有相同名称属性 / 方法 , 就需要使用 super 形式调用指定 父 / 接口方法 ; II ....子类内部类调用父方法 ( super@ ) ---- 子类内部类调用父方法 : 在子类内部类中 , 如果想要访问父方法 , 可以使用 super@子类名称.父方法() 形式 , 调用父方法...子类选择性调用父 / 接口方法 : 子类可以继承 , 实现多个接口 , 如果父与接口 , 或者不同接口之间定义了相同名称方法 , 那么需要使用 super.方法名() 选择调用指定

1.2K10

【错误记录】Groovy 闭使用报错 ( 闭中不能直接使用外部对象方法 | 需要先设置 delegate 代理 )

文章目录 一、报错信息 二、解决方案 一、报错信息 ---- 在 Groovy 中 Closure 闭中 , 直接调用外部对象方法 , 会报错 ; class Test { def fun...Groovy.groovy) at Groovy.run(Groovy.groovy:14) Process finished with exit code 1 二、解决方案 ---- 在 Closure 闭中..., 如果要调用外部对象方法 , 需要先设置 Closure 闭对象 delegate 成员为指定外部对象 ; class Test { def fun() { println..."fun" } } // 闭中不能直接调用 Test 对象中方法 // 此时可以通过改变闭代理进行调用 def closure = { fun() } closure.delegate...= new Test() closure() 设置完 Closure 闭对象 delegate 之后 , 执行效果 :

86220

JavaScript 重构攻略

举个例子,我们经常需要对字符串实现一个 trim 方法,可是 js 本身是不具备,那么就可以在这个 common.js 中扩展 string prototype 实现,这对外部使用者是透明。...变量和方法控制: 模块开发不允许存放独立全局变量、全局方法,只允许把变量和方法放置到相应模块 “命名空间” 中。实在心痒了,那么使用匿名函数如何?...JavaScript 中提供了闭和原型两种办法实现继承和多态,关于重构中应用这一点,后续章节我再啰嗦吧。...如果仅仅想覆写父某个方法,还可以使用 call 或者 apply 尝试一下方法 this 大挪移,略。...(2)对象设计角度来说,一个单例,本身就不适合被继承,那么,还不如把 Player 做成一个纯粹抽象层,让单例这个工作交给其子类 WindowMediaPlayer 去完成。

1.8K20

检查JavaScript文件_TypeScript笔记18

未指定类型参数默认any JavaScript 没有提供用来表示泛型参数语法,因此未指定类型参数都默认any类型 泛型在 JavaScript 中主要以 2 种形式出现: 继承泛型,创建 Promise...等(泛型、Promise 等定义在外部d.ts里) 其它自定义泛型(通过 JSDoc 标明泛型类型) 例如: // 继承泛型 - .js import { Component } from 'react...赋值推断: Class 成员赋值推断 构造函数等价于 null、undefined、[]赋值推断 上下文推断: 不定参数推断 模块推断 命名空间推断 Class 成员赋值推断 .ts里通过成员声明中初始化赋值推断实例属性类型...不定参数推断 .js里会根据arguments使用情况推断是否存在不定参数,例如: // .js function sum() { var total = 0 for (var i = 0...命名空间推断 .js里,、函数和对象字面量都视为命名空间,因为它们与命名空间非常相似(都具有值和类型双重含义、都支持嵌套、并且三者能够结合使用)。

2.4K50

大话 JavaScript(Speaking JavaScript):第二十六章到第三十章

它是 Java 继承而来,大多数风格指南都推荐使用它。其中一个原因是客观。...[[GetOwnProperty]]使得可以通过使用数组索引时包装字符串中读取字符进行索引访问。 Array 自定义内部实例方法[[DefineOwnProperty]]拦截正在设置属性。...JSDoc 生成 HTML 输出。 JSDoc 网站上自述文件解释了如何安装和调用这个工具。 JSDoc 基础知识 JSDoc 全部内容都是关于文档化实体(函数、方法、构造函数等)。...HTML 您可以在 JSDoc 注释中自由使用 HTML。例如,显示单词等宽字体。 类型注释 您可以通过大括号中类型名称记录实体类型。...前者更像是一种类型,而构造函数是实现一种方式。JavaScript 内置定义方法有限,这就是为什么有许多 API 帮助完成这个任务。

12310

JSDoc支持_TypeScript笔记19

Compiler,更多相关讨论见Add support for @template JSDoc 三.类型标注语法 TypeScript 兼容 JSDoc 类型标注,同时也支持在 JSDoc 标记中使用...@returns与@return完全等价,后者是前者别名 构造函数 类型系统会根据对this属性赋值推断出构造函数,也可以通过@constructor标记描述构造函数 二者区别在于有@constructor...var result = C(1); P.S.去掉@constructor标记的话,不会报出这两个错误 另外,对于构造函数或类型参数,可以通过类似于 TypeScript 语法方式描述其类型:...TypeScript 里,继承关系无法通过 JSDoc 描述: class Animal { alive = true; move() {} } /** * @extends {Animal...也不能决定继承关系(继承关系由extends子句决定,JSDoc 描述不算) 枚举 枚举用@enum标记描述,但与TypeScript 枚举类型不同,主要差异在于: 要求枚举成员类型一致 但枚举成员可以是任意类型

4K10

JSDoc 真能取代 TypeScript?

再就是 class 了,这个自然也是支持。 比如声明一个泛型: 这段类型大家能看懂么? 就是声明了一个泛型,有一个类型参数 T。它通过 @extends 继承了 Set 类型。...它有个 name 属性类型为 T,并且还声明了构造器和 sleep 方法类型。 用一下试试: name 和 sleep 类型,继承 Set 类型,都没问题。...这就是 JSDoc 定义 class 类型方式。 综上,用 JSDoc 可以定义变量、函数、class、泛型等,可以别的 dts 文件引入类型。 基本上 ts 能做JSDoc 也都可以。...那我们再看下它怎么用吧: 可以看到,是 js 文件里用 JSDoc 声明类型: 然后复杂类型在 dts 里定义,然后这里引入: 就和我们刚才测试一样。...而且这样也能利用 ts 类型提示和检查能力。 所以很多人就说 svelte 抛弃了 ts。 这叫抛弃么? 并不是,JSDoc 只是另一种使用 ts 方式而已。

31930

JSDoc ,一个可替代 TypeScript 方案?

本文将向您展示如何使用JSDoc获得相同类型控制,同时使用纯JavaScript进行最快开发时间和更好文档编写! JavaScript已经巩固了其作为近年来最常用脚本语言之一地位。...输入完整(描述、构造函数和方法) 更进一步,您还可以使用JSDoc输入完整语法。...,有两个方法计算它面积和周长。...@class 关键字用于表示需要使用 new 关键字调用函数。 @classdec 用于描述整个。在编写时,通过添加类型和描述进一步完善是很重要。...构造函数 中创建所有方法和变量 我们使用 @params 关键字提供需要传递给构造函数参数类型和描述。方法与函数类型方式相同,这在前一节中已经介绍过。

47710

Webpack组件库打包超详细指南

打包配置 不同需求打包配置,放在不同文件中,是很好做法。 我们打包配置有一个基文件,并根据不同打包需求,有不同子类文件——完整组件库打包、单个组件打包、打包示例工程。...相比webpack.prod.js,我们把entry配置为多个入口,遍历components.json填充组件名称和路径信息。output只需要指定一个,用占位符确保输出文件位组件名称。...否则就使用匿名 define }, externals: { vue: { root: 'Vue', commonjs: 'vue', commonjs2...文档生成 jsdoc 这里选择用jsdoc来自动生成文档(后续发现,这里直接用jsdoc生成文档比较不好看,示例不能清楚说明用法,缺少图片和GIF演示,jsdoc做为及时更新API文档是够用,但为了让库用户更方便入手...参考文章 如何打造一套vue组件库 VueJS文档生成

2.6K11

JSDoc 初探:代码内文档标记

假设你想要记录诸如模块、名称空间、方法方法参数等内容。 JSDoc注释通常应该放在记录代码之前。为了被 JSDoc 解析器识别,每个注释必须以 /** 序列开头。...它基于标签(tag)形式,通过注释提取代码中类型、描述、参数、返回值等信息,生成文档供其他人参考。使用JSDoc可以提高代码可读性和可维护性,让代码更易于理解和使用。...在阅读和使用第三方库时,可以通过查看JSDoc生成文档来了解函数和方法使用方式、参数、返回值等信息。...在JSDoc中,可以使用各种标签描述代码不同方面,例如:@param:用于描述函数或方法参数类型和含义;@returns:用于描述函数或方法返回值类型和含义;@throws:用于描述函数或方法可能抛出异常类型和含义...type) 进行判断,避免出现未定义错误。使用=标记具有默认值参数or可选参数在JSDoc中,可以使用 = 符号标记具有默认值参数。

12710

TypeScript 5发布,带来了哪些惊喜?一文告诉你

装饰器是一种即将成为ECMAScript标准功能,可以以一种可重用方式定制和成员。 比如,我们可以用装饰器来给方法添加日志、缓存、验证等功能,而不需要修改原始代码。...除此之外,TypeScript 5还有以下新特性和改进: const 类型参数:允许使用 const 断言约束泛型类型参数; 支持多个配置文件继承:允许 tsconfig.json 文件通过 extends...字段指定多个其他配置文件; 所有枚举都是联合枚举:使得枚举类型更加灵活和安全; –verbatimModuleSyntax :支持 export type * 语法; @satisfies 支持 JSDoc...:允许使用 @satisfies 标签指定实现了某个接口或抽象; @overload 支持 JSDoc:允许使用 @overload 标签定义函数重载; 在 –build 下传递生成相关选项:允许在使用...–build 选项时传递其他生成相关选项; switch/case 完备性提示:在编辑器中提供 switch/case 完备性提示; 性能、内存和大小优化:通过各种方式提高了编译速度、降低内存占用和减小包大小

39730

Angular 工具篇之文档管理

工具篇之VSCode调试 Angular 工具篇之Storybook Angular 工具篇之国际化处理 Angular 工具篇之npx及angular-cli-ghpages Angular 工具篇之分析大小...文档注释 comments Compodoc 使用 TypeScript AST 解析器和它内部 API,因此注释必须是合法 JSDoc 注释。...@param —— 定义一个参数类型和描述 @link —— 定义链接另一个方法、文档或外部链接 @example —— 定义一个示例用法 了解完上述标签,我们来看一个比较完整示例(来源于 ionic-code-documentation...总结 本文简单介绍了如何利用 Compodoc 这款工具,为 Angular 应用程序生成静态文档,Compodoc 基本上能够满足我们需求。...对 Angular 项目来说,除了 Compodoc 之外,你也可以考虑使用谷歌官方出品 API 文档生成工具 Dgeni,它对外开放了丰富接口,还支持插件扩展,具有非常强定制性。

1.6K10

TS in JS 实践指北

比如定义一个变量,下一行使用时候,VSCode 会知道这个变量是哪来。 但是在自定义函数里面,IDE 不知道传参类型,因此这些函数里入参缺失了 type,成了 any。...demo 你可能不知道 JSDoc: 在上面的基础上,我们进一步研究下面这个代码。...2.类似require方法引入丢失类型: 很多老代码里有自己实现加载其他方法,这里叫someRequireFn吧。...vue type 这里我们另一个角度考察它,不依靠插件能力,不多修改代码本身,并能使用官方提供 TS 能力。 注:以下内容包含了泛型知识点,只需要应用同学可以直接拉到结论部分。...在 JS 里使用 TS 能力方法 1.使用声明文件2.使用 JSDoc 这两种方式还可以一起作用,实现一些复杂类型效果。

4.4K20

如何编写高质量 JS 函数(2) -- 命名注释鲁棒篇

) 不会使用辅助工具(如何使用辅助工具) 下面进行简明扼要分析。...所以我把前端函数命名分为两大类,如下: 第一:不想暴露给外部访问函数(比如只给内部使用) 第二:暴露给外部访问函数(各种功能方法) 而Symbol 初始化函数命名是一种特例,代码如下:​​​​​​...我观点是,对一些不需要开源 web 项目,没有必要用 jsdoc , 理由如下: 1.繁琐,需要按照 jsdoc 规则。 2.个人认为,jsdoc 有入侵性,文档规则需要写在代码中。...第三个方法:如果既有异步操作又有同步操作 最好方式就是使用最新语法:async/await 结合 promise 和 try/catch 完成对既有同步操作又有异步操作异常捕捉。...第四种方式:使用函数式编程中函子( Monad )等对异常处理进行统一裹,这里 Monad 和 try/catch 在表现上都相当于一个容器,这是一个相当强大方法

1.4K20

我们如何为 JavaScript 客户端减半模块化 AWS SDK 发布规模

我们浏览了每个文件被发布到npm客户-s3,并问自己它扮演什么角色。我们集思广益,并将它们记录在 GitHub 问题中。然后,我们按投资回报率下降顺序实施这些想法。...复制代码 Bash 我们*.d.ts文件中删除了注释 为了支持使用旧版本类型脚本客户,我们使用 downlevel-dts 将具有新类型脚本功能代码转换为使用等效旧功能代码下级类型。...复制代码 Bash 因此,使用 4.0 以上 TypeScript 版本客户不会在其 IDE 中看到 JSDoc 评论,尽管下级类型将起作用。...加入 Twitter上对话 让我们知道您是如何减少发布/安装/捆绑大小在你npm或任何其他经验,你已经与AWS SDK为JavaScript。 我们计划将来做什么?...如果您有关于类型脚本源代码和源图反馈,或想解释您调试或其他使用案例,请评论 GitHub 问题 aws/aws-sdk-js-v3/#2895. 您如何做出贡献?

2.3K20

如何不编译使用 TypeScript

四月份发布TypeScript 2.3支持通过注释中类型说明来对原生 JavaScript 代码进行近代分析。您可以使用 JSDoc 语法描述函数功能并添加类型信息。...TypeScript 工具注释中读取类型注释,并以与使用 TypeScript 自己类型系统相同方式使用它们。...编辑器还使用类型注释增加其他特性,例如自动完成。...以下示例显示了如何描述远程 API 获取 JSON 对象结构: /** * @typedef {Object} Issue * @property {string} url * @property...WEB前端性能优化常见方法 一小时内搭建一个全栈Web应用框架 干货:CSS 专业技巧 四步实现React页面过渡动画效果 让你分分钟理解 JavaScript 闭 ---- ---- 小手一抖,

1.9K40
领券