jsdoc

1热度

1回答

我正在寻找在我的文档中有JSON示例，而我的文档中将会有我的智能感知VScode中的JSON示例。我已经试过本书中的每一个技巧，我可以想到，这是可能做的换行符和使JSON可读的东西吗？无论我做什么，我都无法在VScode中使用它，它会占用空白区域并制作一行。我尝试这样做： /** * { * "JSONData":"not going to format like this" * }

1热度

1回答

VS代码中的jsDoc @callback

VS代码中有没有某种方法可以使用jsDoc的@callback标签？我试图从jsDoc documentation of the callback tag剪断下面的代码： /** * @class */ function Requester() {} /** * Send a request. * @param {requestCallback} cb - The callback

0热度

1回答

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

我正在用Mac上的Visual Studio Code编写Javascript。我有这个功能，在JSDoc格式记录： /** * Adds the passed Matter Body to the simulation. * @param {Matter.Body} body - The body to add to the physics simulation * @param {st

1热度

1回答

手动JSDoc注释 - 创建模板

我被要求为我们的开发人员创建一个JSDoc模板来记录他们的ES6代码。我不确定哪个70 or so @ block tags会有用，以及我是否会让开发人员陷入过多的文档要求。 documentation给出了非常简单的例子，这实际上没有帮助。寻找对经验丰富的JavaScript开发人员最有用的一组块标签的真实世界体验。当我问我们的时候，他们只会说：“无论你决定！”，但称他们为有经验的JavaSc

2热度

1回答

如何在JSDoc中正确定义自己的类的类型？

我有一个简单的ES6类，我想知道如何在JSDoc中正确地描述它。请注意，我想定义我自己的类型，稍后将由WebStorm自动完成识别。下面的示例有效吗？ /** * @typedef {Object} View * @class */ class View{...}

0热度

1回答

有申报通过JSDoc语法类型参数中的javascript打字稿了解

这个文件的方式： https://github.com/Microsoft/TypeScript/wiki/JSDoc-support-in-JavaScript 没有提及类型参数问题：是通过JSDoc类型注释支持的类型参数S' 如果是这样，我该怎么做？

-1热度

1回答

在Angular项目上运行的JavaScript JSDoc

我正在使用Angular CLI构建的Angular 4项目。接下来，我想安装JSDOC 我这样做如下说明： - npm install -g jsdoc - npm install --save-dev jsdoc 所以，现在我把它安装。我的问题是......我下一步要做什么来生成doc文件？它说，在文档中运行此命令： jsdoc yourJavaScriptFile.js 是什么意

1热度

2回答

jsdoc和vscode：记录一个函数作为参数传递给另一个函数

我试图在javascript中记录输入参数到一个函数，但我无法解决如何在jsdoc中执行它。我看了一下jsdoc文档，它建议使用@callback评论是必需的，但Visual Studio代码（vscode）不会按照屏幕截图来突出显示它。用于location参数的智能感知表明，它的类型any而非locator类型（具有id一个参数，它返回一个Location的函数）的。示例代码显示了一个函数

0热度

1回答

Tern无法使用JSDoc类型信息

我试图使用Tern对某些Javascript代码执行类型推断。但是，类型推断似乎并没有在代码中使用JSDoc注释。我使用代码/** @type {Foo} */ let x;作为问题的示例。在Tern website's demo page（使用CodeMirror）上，编辑器能够推断出x的类型为Foo。然而，当通过节点本地运行时，我得到了这个：{ type: '?', exprName: '

2热度

1回答

引用node.js中的* documentation * @return语句

我们这里所说的全部是关于代码记录。要有两个功能，f1和f2： /** * @return {Boolean} always true */ const f1 =() => true; /** * @return {Boolean} always true */ const f2 =() => { console.log('friendly wrapper of f1(