jsdoc 相关问题

JSDoc是一种用于向JavaScript源代码添加内联API文档的语法。这与解析和操作遵循JSDoc语法的代码的各种工具不同。

使用JSDoc记录事件监听器

我有这个类的构造函数:/ ** * @class游戏渲染器。 * @exports渲染器* @constructor * @param {number =} width画布宽度。默认值为1024。* @param {number =} height画布高度。 ...

回答 1 投票 0


JSDoc不显示参数表和返回值/名称/描述

我已经开始为我的项目实现JSDoc,并且根据文档,函数头如下:/ ** * @name randomGenerateMixedCaseLetterOrSpecialCharacter1 * @description随机...

回答 1 投票 0

[JSDoc,对于Interace遇到Typescript错误:错误:无法解析

我试图在react typescript项目中使用JSDocs,对于具有接口错误的文件,我得到此错误:无法解析C:******* /file.ts:此实验性语法需要启用一个...

回答 1 投票 0

javascript中的google客户搜索结果对象的麻烦阅读结果

有人知道在读取Google自定义搜索结果对象时使用的语法吗?这是来自https://developers.google.com/custom-search/docs/element的结果对象的JSDoc表示法:...

回答 1 投票 1

Jsdoc不排除路径

我正在使用Jsdoc 3.6.2。我在conf.json中具有以下源配置:“ source”:{“ exclude”:[“ MyProj / excludeFolder”],“ includePattern”:“。+ \\。js(doc | x | xinc)?$”,“ ...

回答 1 投票 0

jsdoc-参数对象内的默认属性值

对于以下jsdoc @param对象,如何为name分配默认值? / ** @param入站{{电子邮件:字符串,名称:字符串,要求:要求}} * /我已经尝试过/ ** ...

回答 1 投票 0

如何记录返回函数调用的函数(用于尾部调用优化)

我正在尝试熟练使用JSDoc,并且我有这种方法:/ ** *清理步骤。 * * @return {Void} * / beforeDestroy(){window.removeEventListener('resize',this.onResize); },这似乎是...

回答 1 投票 0

Google表格自定义函数支持多少JsDoc?

Google表示支持JsDoc:如果自定义函数的脚本包含JsDoc @customfunction标记,则该函数将出现在此列表中,如下面的DOUBLE()示例所示。 https:// developers ....

回答 1 投票 1

vscode中的tensorflowjs的智能感知

npm模块@ tensorflow / tfjs具有声明文件,该声明文件具有如下注释结构:/ ** *创建一个新数组,该数组具有给定数量的随机索引。 * *```js * const ...

回答 1 投票 0

我如何获得我的匿名事件处理程序的智能感知?

我创建了一个JavaScript工作者。它将消息发送回主页。这些消息通常由事件处理程序处理。消息事件数据属性将包含定义为以下对象的对象:...

回答 1 投票 0

为什么要在Vuex状态定义中记录类型呢?

我们在一个组件中有一个相当大的状态,其中的代码就像导出默认值{someObject:{},someOtherObject:{},evenMore:[] }如果没有任何类型,很难想像...

回答 1 投票 0

如何使用JSDoc扩展另一个类的文档类型参数?

假设我具有定义一个类的此javascript代码。它的静态方法之一返回一个用于实例化子级的类。 class ParentClass {/ ** *创建父级实例...

回答 1 投票 0

javascript @param和@return注释中的感叹号表示什么?

我正在尝试遵循以下准则:/ **一个可以执行某些操作的类。 * / class SomeClass扩展SomeBaseClass {/ ** *在MyClass的实例上运行并返回某些内容。 * @param {!...

回答 1 投票 1

将jsdoc / typescript类型限制为数组成员

我正在jsdoc中使用typescript,并试图将变量限制为数组中具有的一组已知值中的一个。我知道我可以这样做:/ ** @type {'one'|'two'|'three'} * / let v = ...

回答 1 投票 0

JSDoc:如何包含多个.md文件

这是我第一次被要求编写文档,而我选择使用jsdoc的方式。以下是我的jsdoc的示例jsdoc.json配置文件。它只读取一个...

回答 1 投票 0

在JsDoc 3中,注释返回对象的正确方法是什么?

我在我的React项目中使用JSDoc 3.6.4。我定义了以下钩子……从“ react”导入{useState}; / ** *表单挂钩。设置表单的处理程序和初始属性。 * * @ ...

回答 1 投票 0

我何时应该使用JSDocs?

我知道导出JSDocs的功能非常有用,但是在其他情况下我应该使用它呢?例如,为不导出的功能添加JSDocs是否有意义?

回答 1 投票 0

我如何正确记录此通用功能?

/ ** *包装样式组件以提供默认道具* @template {T}-组件类型* @template {TDefaults}-默认道具* @param {T} component-我们的样式组件对象* @param {.. 。

回答 1 投票 1

JSDoc“ includePattern”多种文件类型

我刚刚开始使用JSDocs,并试图将其应用于我的Vue.js项目。由于它包含多种文件类型(即.js和.vue),因此我尝试将它们添加到“ includePattern”中,但是我是...

回答 1 投票 0

© www.soinside.com 2019 - 2024. All rights reserved.