jsdoc 相关问题

基于参数值的动态返回类型JSDoc

我一直在尝试用类型记录我的 JS 代码，但是在使用这个函数时遇到了问题。我正在尝试使用数组的 type 属性来过滤数组，但是当尝试映射提供的字符串时

Storybook 文档页面在描述中显示额外的 JSDOC 标签

我的组件在 Storybook Docs 页面上的描述除了描述之外还从 JSDocs 中获取额外的标签内容。 我怎样才能只显示“描述部分&qu...

在 v6 中通过 JSDoc 使用 styled-components 属性

如何使用 JSDoc 结合 tsconfig.json 和 tsc 来输入样式组件的 props。 在 TypeScript 中，使用简单的泛型就非常容易，不幸的是我无法实现相同的目的...

如何编写带有参数的@typedef？ （就像 CustomEvent 的详细信息类型参数）

假设我有一个描述 API 响应的类型： /** * @typedef {{ * 状态：字符串， * 代码： 数字， * 类型：字符串， * 数据：T[]， * }} API响应 */ 其中 T 可以是任何一个麻木...

在 Google Sheets JSDoc 自定义函数中转义大括号

我正在为我在 Google Sheets 中开发的函数编写文档。 这是 JSDoc 代码： /** * 在字符串模板中渲染结果。 * * @param {“这是{{item1}}。”}模板 *

为什么 jsDoc 不解析我没有尾随代码的评论？

我在jsdoc中添加了一个新插件，引入了一个新标签： Dictionary.defineTag("newtag", { 必须有值：假， canHave类型：假， 可以有名称：true， onTagged：函数（doclet，标签）...

在 JSDoc 上重用对象作为类型

我想使用在类的构造函数中定义的对象作为类本身函数中的类型。 我想做这样的事情，这样自动完成功能就可以工作： 班级

路由参数无法从 ExpressJs api 中的 Swagger UI 正确填充

我正在将 Swagger 实现到 ExpressJs API 应用程序中。在控制器文件中，我们使用嵌套文件夹和“const router = require('express').Router({ mergeParams: true });”到

如何成功使用内部有自己导入的 TypeScript 文件中的接口？

我正在使用 WebStorm 开发一个 React JavaScript 项目，并尝试使用 TypeScript 接口和 JSDoc 注释为我们的 IDE（以及 VS Code）实现类型提示（希望我们能

使用脚本标签时的 JSDoc 智能感知

问题 我发现当 JSDoc 类型的代码位于项目“内部”时，JSDoc 可以很好地与智能感知和类型检查配合使用；但是，通过脚本标签包含 JSDoc 类型的库...

如何使用 typedoc 记录 useState 调用？

我有一个记录的钩子，它返回一个状态和几个函数。 typedoc 中的函数已被记录，但最终文档中的状态仅显示为布尔值，没有

JSDOC 其他类型参考键

如何在 @type 或 @typedef 中引用另一个对象的键？ /** * @typedef {{name: {name: string}}} 哞 * @typedef {{name: moo.name}} moo2 */ 我希望 vscode 能够解决我...

JSDoc 如何添加对象的任何附加属性？

我有一个 typedef 的 JSDoc 注释，如下所示， /** * Lorem ipsum 悲伤... * @typedef {Object} 通知选项 * @property {boolean} foo - 属性 1 * @property {boolean} 栏 - 属性 2 ...

如何在JSDoc中创建类别？

背景 我正在记录我自己的 JS 库，并且偶然发现了 lodash 库（https://lodash.com/docs/4.17.4）。 它的文档有一个带有类别的侧边栏（数组、集合、ec...

如何让 JSDoc/TypeScript 理解 JavaScript 导入？

我已将 // @ts-check 添加到 JavaScript 文件中以使用 JSDoc。突然，我在 VS Code 中遇到脚本标记中包含的函数的错误： ...

jsdoc二维数组

我有一个字符串数组的数组，但我不知道如何使用 JSDoc 来记录它。 /** @班级 */ 函数回传列表() { /** @类型{int} @默认 */ 这个.TypeID = 0; ...

如何使用 JSDoc 或 TypeScript 为返回的对象 props 添加描述？

我有一个 TypeScript 项目，并且有一个自定义挂钩，它返回一堆变量是桌面 | ...我想为每个变量添加一个描述，以便在公关中的某个地方...

找不到名称“myFun”（在包含文件“my-funs.js”中定义）

函数 myFun 在包含的文件中定义： 包含文件具有 // @ts-check 和该函数的 JSDoc 注释： /** * * @par...</desc> <question vote="-1"> <p>函数<pre><code>myFun</code></pre>在包含的文件中定义：</p> <pre><code>&lt;include src=&#34;my-funs.js&#34;&gt;&lt;script&gt; </code></pre> <p>包含文件有 <pre><code>// @ts-check</code></pre> 和该函数的 JSDoc 注释：</p> <pre><code>/** * * @param {*} type * @param {*} attrib * @param {*} inner * @returns {*} */ function myFun(type, attrib, inner) { // code } </code></pre> <p>我正在使用 VS Code，它告诉我标题中的错误。</p> <p>我期望 JSDoc/TypeScript 找到 <pre><code>myFun</code></pre> 的声明，但显然我错了。</p> <p>我错过了什么？</p> </question> <answer tick="false" vote="-1"> <pre><code>/** * * @param {string} type * @param {string} attrib * @param {string} inner * @returns {string} */ function myFun(type, attrib, inner) { } </code></pre> <p>尝试添加类型而不是 *，因为打字稿依赖于类型注释</p> </answer> </body></html>

JsDoc：找不到名称“myFun”（在包含文件“my-funs.js”中定义）

函数 myFun 在包含的文件中定义： 包含文件具有 // @ts-check 和该函数的 JsDoc 注释： /** * * @par...</desc> <question vote="0"> <p>函数<pre><code>myFun</code></pre>在包含的文件中定义：</p> <pre><code>&lt;include src=&#34;my-funs.js&#34;&gt;&lt;script&gt; </code></pre> <p>包含文件有 <pre><code>// @ts-check</code></pre> 和该函数的 JsDoc 注释：</p> <pre><code>/** * * @param {*} type * @param {*} attrib * @param {*} inner * @returns {*} */ function myFun(type, attrib, inner) { // code } </code></pre> <p>我正在使用 vscode，它告诉我标题中的错误。</p> <p>我期望 JsDoc/typescript 找到 <pre><code>myFun</code></pre> 的声明，但显然我错了。</p> <p>我错过了什么？ （我正在尝试学习一些 JsDoc 来测试它目前对我是否可用，但没想到会出现这个级别的问题。）</p> </question> <answer tick="false" vote="0"> <pre><code>/** * * @param {string} type * @param {string} attrib * @param {string} inner * @returns {string} */ function myFun(type, attrib, inner) { } </code></pre> <p>尝试添加类型而不是 *，因为打字稿依赖于类型注释</p> </answer> </body></html>

毫秒 vs 秒，当我混淆时 JsDoc 可以告诉我吗？

我想学一点 TypeScript 和 JsDoc。对我来说，常见的情况是我碰巧混合了不太相同的数值。作为一个简单的例子（也许不太现实）让我们...