JSDoc是一种用于向JavaScript源代码添加内联API文档的语法。这与解析和操作遵循JSDoc语法的代码的各种工具不同。
问题 我发现当 JSDoc 类型的代码位于项目“内部”时，JSDoc 可以很好地与智能感知和类型检查配合使用；但是，通过脚本标签包含 JSDoc 类型的库...
我有一个记录的钩子，它返回一个状态和几个函数。 typedoc 中的函数已被记录，但最终文档中的状态仅显示为布尔值，没有
如何在 @type 或 @typedef 中引用另一个对象的键？ /** * @typedef {{name: {name: string}}} 哞 * @typedef {{name: moo.name}} moo2 */ 我希望 vscode 能够解决我...
我有一个 typedef 的 JSDoc 注释，如下所示， /** * Lorem ipsum 悲伤... * @typedef {Object} 通知选项 * @property {boolean} foo - 属性 1 * @property {boolean} 栏 - 属性 2 ...
背景 我正在记录我自己的 JS 库，并且偶然发现了 lodash 库（https://lodash.com/docs/4.17.4）。 它的文档有一个带有类别的侧边栏（数组、集合、ec...
如何让 JSDoc/TypeScript 理解 JavaScript 导入？
我已将 // @ts-check 添加到 JavaScript 文件中以使用 JSDoc。突然，我在 VS Code 中遇到脚本标记中包含的函数的错误： ...
我有一个字符串数组的数组，但我不知道如何使用 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><include src="my-funs.js"><script> </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><include src="my-funs.js"><script> </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>
我想学一点 TypeScript 和 JsDoc。对我来说，常见的情况是我碰巧混合了不太相同的数值。作为一个简单的例子（也许不太现实）让我们...
DocuSaurus 中是否有插件或库可用于将 JavaScript 代码和注释转换为文档？ 我发现的唯一选择是使用 jsdoc-to-markdown，我想知道......
我一直在学习如何在我的项目中使用 JSDoc，除了一两件事之外，我大部分都了解如何使用它。其中之一就是记录事件监听器。 我见过
为使用松散增强的模块添加 jsdoc 文档的正确方法是什么？或者我只是错误地设置了我的实现？我最终希望我的共享成员能够...
JSDoc - 如何在 Eclipse 中检查 JavaScript 类型？
我正在应用 JSDoc 注释： /** * @param {number} 毫秒 * @param {function} 回调 * */ 函数睡眠（毫秒，回调）{ 设置超时（函数（）{ 打回来（）; }，毫利斯）...
我正在寻找类似 ESLint 的东西，但它实际上会根据 JSDoc @param 标签验证类型。我尝试了 ts-node 但它似乎没有强制执行。例如，这不会抛出： /** * 一个...
在 javascript 中，使用 JSDoc，我正在查询页面上的元素： // @ts-检查 /** @type {HTMLInputElement} */ const element = document.getElementById('checkbox'); 但我收到警告： 输入“
如何使用 jsdoc 记录一组从另一个函数的返回值解构而来的函数？
首先，我已经阅读了这个问题/答案，它不太适合我的情况。 我正在调用一个库函数，它动态创建并返回一个函数数组。然后我的模块...
我有一个名为namespace.event 的事件。当我想使用标签 @fires 时，这些点会在 JsDoc 中引起问题。当我做： /** @fires MyClass#namespace.myevent */ 我得到的结果是纯文本M...
VScode 中带有上次修改时间的自动 JSDoc 风格注释
在 Sublime text 中，有一些选项或插件允许您将其放在文件顶部： /** *@最后修改时间： */ 每当您保存时，它都会添加实际时间