jsdoc

0热度

1回答

我在代码中有几次的基本模式是exports.thing = thingFromSomewhereElse，我想记录thingFromSomewhereElse的函数成员，就像我自己定义它们一样。但我不明白如果没有实际的thing.functionName = function() {...}这样做怎么办。如果我尝试使用@callback标记，JSDoc会将它归类为类型定义而不是成员。有没有办法让它

16热度

1回答

JSDoc typedef在单独的文件中

我可以在单独的文件中定义所有自定义类型（例如types.jsdoc），以便它们可以在整个应用程序中重用？什么是正确的做法？ /** * 2d coordinates. * @typedef {Object} Coordinates * @property {Number} x - Coordinate x. * @property {Number} y - Coordinate y. *

0热度

1回答

JSDoc - 如何分配功能作为另一个功能

给出下面，当我运行jsdoc，输出不显示为foo.bar任何财产的属性。 /** * Foo */ const foo = function foo() { //... } /** * Bar */ foo.bar = function bar() { //... } 如何显示bar为上foo的属性？

0热度

2回答

如何解决此ESLint/JSDoc语法错误？

我已经证明这个功能... /** * Perform an asynchronous HTTP (Ajax) request. * * @param {String|Object} url A string containing the URL to which the request is sent, or the settings object. * @param {Object=}

0热度

1回答

jsdoc使所有下划线方法私有

我有一个使用jsdoc的大型代码库。我们只注意到很多私有方法没有@private标志。有没有一种方法来设置配置地看到，下划线作为私有开始的所有方法？我真的很想避免不得不通过数百个文件手动完成。

1热度

1回答

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

我对Javadoc很熟悉。在Javadoc，you can place a link that refers to the Javadoc placed on another type像这样： /** * some java thingy. see this other java thingy too {@link OtherThingy} */ public class Thingy {

0热度

1回答

JSDoc可以链接到源代码行吗？

有没有办法让jsdoc直接链接到源代码文件中的行而不是仅仅到文件的开头？

2热度

1回答

如何在jsdoc中使用@param

我知道这是一个愚蠢的问题，但我刚开始使用jsdoc，并且遇到了试图生成doc文件的问题。我跟踪了一些我在网上发现的例子，这些例子看起来基本相同，但由于某些原因，我无法生成我想要记录的变量之一的文档。这是我的代码。 /** *@fileOverview mainController ' main controller file' *@param Controller here */ fu

0热度

1回答

如何使用jsdoc对ES6类@mixes结合WebStorm

使用的对象JSDoc的@mixin，我可以写这样的事： /** * @mixin foo */ const foo = { myMethod() {} } /** * @mixes foo */ const bar = { } 和我WebStorm IDE显示bar有myMethod方法。我喜欢用从核心装饰的@mixin装饰在我班上一些对象混合： /* * @

2热度

3回答

如何使用打字稿jsdoc注解阵营PropTypes

定义时使用的反应打字稿组件，我们可以写类似： class SomeComponent extends React.Component<PropInterface, StateInterface> { // ... } 有没有办法做相当于使用jsdoc annotations，并有道具类型检查。