JSDoc是一种用于向JavaScript源代码添加内联API文档的语法。这与解析和操作遵循JSDoc语法的代码的各种工具不同。
如何使用 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 中，有一些选项或插件允许您将其放在文件顶部： /** *@最后修改时间： */ 每当您保存时，它都会添加实际时间
我知道可以将整个属性注释为已弃用，但是是否可以将字符串联合中的一个（或多个）单个值注释为已弃用？ 例如，给定这个类型声明...
我一直在尝试使用 JSDoc 来记录 JS 中的重载函数： 有 2 个用例： 分配Slave（票证，用户ID）； allocateSlave(票，名字，姓氏); 我想让它看起来像这样
我在 JavaScript 中有以下两行： /** @类型 {*} */ const Slides = document.getElementsByClassName("x"); 我正在使用 JSDoc 来记录这一行。 “*”需要重新填写...
我正在使用 JSDoc 并对 Stream 有以下定义： /** * @模板T * @callback流 * * @param {T} [值] * * @return {T} 值 */ 这正确地翻译为...
如何使用 VS Code 将 typedef 从一个文件“导入”到 JSDoc 中的另一个文件？
假设我有一个名为“File1.js”的文件。在这个文件中，我导出一个对象的对象，并为每个对象提供一个 typedef，如下所示。 /** * 我为每个对象定义的类型。 * @typedef {Object} MyObject1 *@
当函数使用与预期不同数量的参数时，为什么 TypeScript 不发出警告？
我在 VS Code 中有一个普通的 JavaScript 项目，设置了 jsconfig.json 和以下示例代码： /** * @param {(arg: string) => void} 嵌套函数 */ 函数 myFunction(nestedFuncti...
我花了相当长的时间在互联网上搜索，寻找使用 jsdoc 正确记录回调的最佳方法，但不幸的是，我还没有找到一个很好的方法。 这是我的问题： 我已书面...