jsdoc 相关问题

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

扩展对象的文档

我正在编写一些赛普拉斯和javascript进行一些测试,我有一个Object cy。这个对象是有记录的,我得到了一些intellisense,但是我想用我自己的一些来扩展它...

回答 1 投票 1

VS代码中的Vue数组支持JSDoc TypeScript错误:类型'ArrayConstructor'缺少类型'MyCustomType []'的以下属性

受“使用JSDoc进行类型检查”部分的启发“为什么我不再使用带有React的TypeScript以及为什么你也可能想要切换”,我使用的是Vue CLI创建的项目与ES6但没有TypeScript ...

回答 1 投票 0

如何使用有限的可能值记录jsdoc中的字符串类型

我有一个接受一个字符串参数的函数。此参数只能包含一些已定义的可能值。记录相同内容的最佳方法是什么?应将shapeType定义为......

回答 5 投票 60

我如何在comments / JSDoc中引用另一个打字稿类型?

我对Javadoc很熟悉。在Javadoc中,你可以放置一个引用Javadoc的链接放在另一个类型上,如下所示:/ ** * some java thingy。看到这个其他的java东西{@link OtherThingy} * / ...

回答 1 投票 4

如何通过文件/模块分离JSDoc

当我生成文档时,它将所有函数文档放在一个文件中。除了为每个文件多次调用JSDoc然后重命名之外,有没有办法使用...分隔文档

回答 1 投票 1

vscode在JavaScript文件中使用类型化定义

VSCode版本:1.20.0首先,我想我对Visual Studios Code IntelliSense的了解:tsconfig.json / jsconfig.json的存在应该向vscode指示该目录是TypeScript / ...

回答 1 投票 3

如何在YUIdoc / jsdoc中使用@throws记录多个错误?

根据YUIdoc的文档(在这种情况下似乎等同于jsdoc),有一个@throws标记来记录可能抛出的错误。指定方法抛出的错误。 ...

回答 2 投票 0

JSDoc中属性访问器的“无效类型语法”

我们的自定义类有一个容器对象,但JSDoc似乎不喜欢我对这些类型的表示法,并用“无效的类型语法”对它们进行注释。我正在使用PHP-Storm。我的JSDoc是......

回答 1 投票 0

JavaScript reducer累加器的打字稿的JSDoc打字

我试图使用JSDocs在JavaScript reducer中键入累加器,但无法解决如何执行此操作。我尝试在初始化时输入内联但是没有用。任何提示或想法? ...

回答 1 投票 2

我在哪里可以存储JSDoc typedef信息以跨项目共享?

我将@typedef JSDoc注释添加到Javascript文件的顶部以帮助定义类型(实际上,这样我就可以利用一些打字稿的好处,而无需今天学习它们)。哪里......

回答 1 投票 2

JSdoc用于文件流

我正在创建一个流: - var stream = fs.createWriteStream(“filepath”);现在,我将此作为参数传递给函数。在为这个方法编写JSdoc时,我不确定它会是什么......

回答 1 投票 6

如何让JSDoc将我的param标记为jQuery对象?

我试图彻底评论我的JavaScript,我正在使用JSDoc。我有一个消耗jQuery对象的函数,我想将参数标记为这样。目前,我有这个:/ ** * ...

回答 1 投票 27

JSDoc文档对象方法扩展其他类

Document使用JSDoc扩展jest.Matchers我编写了一个jest.Matchers的简单扩展,但是我无法使用typescript类型检查器来识别我的扩展。我使用的是纯JavaScript。 // @ts -...

回答 1 投票 1

PhpStorm / WebStorm中的CoffeeScript JSDoc支持

在PhpStorm / WebStorm中工作时,有没有办法使用JSDoc来注释用CoffeeScript编写的源代码?在IDE中工作时,能够使用JSDoc来获取正确的代码非常有帮助...

回答 3 投票 10

如何使用Visual Studio Code的Intellisense查看函数的文档?

我在Mac上用Visual Studio Code编写Javascript。我有这个函数,以JSDoc格式记录:/ ** *将传递的Matter Body添加到模拟中。 * @param {Matter.Body}身体 - ......

回答 1 投票 0

使用可选的第一个参数记录JavaScript

我正在尝试记录其中一个烦人的函数,它们在JavaScript中有一个可选的第一个参数。类似函数.use()来自快递函数使用(路径,回调)//路径是......

回答 1 投票 2

如何使用JSDoc记录导出类实例的模块

我正在开发一个Javascript项目,其中默认导出(即,当您需要模块时获得的内容)是扩展类的类的实例。例如:/ ** * @module my-module -...

回答 1 投票 0

如何使用JSDoc记录ES6类的实例

根据如何使用JSDoc记录ECMA6类来定义一个类? :/ ** *表示某些动作的类* / class someActionClass {}现在我该如何定义它的实例?可能如下:/ ** ......

回答 1 投票 0

如何使用混合参数类型记录JSDoc?

当参数类型可以混合时,如何使用JSDoc在JavaScript中记录方法?我在Dialog对象上有方法,我可以在其中显示HTML或我自己的Viewable对象。方法JSDoc看起来......

回答 2 投票 18

使用JSDoc记录Objects中包含的函数

我正在寻找一种方法来记录使用JSDoc 3在Javascript中的Dictionary中包含的函数。尽管我告诉JSDoc有@function的函数,它不包含在生成的...

回答 1 投票 1

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