- 45
- 0
使用 jsdocs 如何描述参数/返回值是 class 呢
场景
类似于下面这种情况,参数和返回值均为 class 类型,那么 jsdocs 应该如何写?
/**
* 通用的单例模式
* @param {any} clazz 需要包装为单例的类型
* @returns {any} 包装后的单例模式类,使用 {@code new} 创建将只在第一次有效
*/
吾辈目前直接使用的 any,消除了检查错误,但感觉不好
- 共 0 条
- 全部回答
-
是我不夠好 普通会员 1楼
在使用 jsdocs 描述参数和返回值是 class 的情况下,你需要使用类的描述注释(TypeDoc)和参数的描述注释(TypeScript注释)。
下面是一个简单的例子:
typescript /** * An example class. */ class ExampleClass { /** * An example method. * @param {string} name - The name of the example method. */ method(name: string): void { console.log(`Hello, ${name}!`); } }在这个例子中,
ExampleClass是一个类,它有一个方法method。method方法接受一个参数name,并打印出一条消息。对于参数,你可以在类的描述注释中添加如下描述:
typescript /** * An example class. */ class ExampleClass { /** * An example method. * @param {string} name - The name of the example method. * @param {number} age - The age of the example person. */ method(name: string, age: number): void { console.log(`Hello, ${name}! My age is ${age}.`); } }在这个例子中,我们添加了两个参数的描述注释。每个参数都有一个描述,包括参数的名称、类型和默认值。
你可以使用这些描述来帮助其他开发者理解你的代码是如何工作的。
- 扫一扫访问手机版
回答动态

- 神奇的四哥:发布了悬赏问题阿里云幻兽帕鲁服务器更新之后。服务器里面有部分玩家要重新创建角色是怎么回事啊?预计能赚取 0积分收益

- 神奇的四哥:发布了悬赏问题函数计算不同地域的是不能用内网吧?预计能赚取 0积分收益

- 神奇的四哥:发布了悬赏问题ARMS可以创建多个应用嘛?预计能赚取 0积分收益

- 神奇的四哥:发布了悬赏问题在ARMS如何申请加入公测呀?预计能赚取 0积分收益

- 神奇的四哥:发布了悬赏问题前端小程序接入这个arms具体是如何接入监控的,这个init方法在哪里进行添加?预计能赚取 0积分收益

- 神奇的四哥:发布了悬赏问题阿里云幻兽帕鲁服务器刚到期,是不是就不能再导出存档了呢?预计能赚取 0积分收益

- 神奇的四哥:发布了悬赏问题阿里云幻兽帕鲁服务器的游戏版本不兼容 尝试更新怎么解决?预计能赚取 0积分收益

- 神奇的四哥:发布了悬赏问题阿里云幻兽帕鲁服务器服务器升级以后 就链接不上了,怎么办?预计能赚取 0积分收益

- 神奇的四哥:发布了悬赏问题阿里云幻兽帕鲁服务器转移以后服务器进不去了,怎么解决?预计能赚取 0积分收益

- 神奇的四哥:发布了悬赏问题阿里云幻兽帕鲁服务器修改参数后游戏进入不了,是什么情况?预计能赚取 0积分收益
- 回到顶部
- 回到顶部

