JSDoc是一种用于向JavaScript源代码添加内联API文档的语法。这与解析和操作遵循JSDoc语法的代码的各种工具不同。
我有一个场景，我有一个函数，我们不想将其包含在 Jest 测试覆盖范围中，但我们仍然希望将其包含在 JSDoc 文档生成中。对
如果我将函数定义为变量对象，那么 PhpStorm 将显示 item 参数的自动完成。 /** * @param {Rules.FolderGroupItem} 项目 **/ 变种
我正在编写一些 JavaScript 模块，试图使用 JsDocs 在 VsCode 上运行智能感知 但现在我正在努力尝试为以下情况编写 JsDoc： 假设我有这个...
如果我有箭头函数，包装在 React useCallback 中，我应该如何使用 JSDoc 记录它？ const floopPig = useCallback((pigKey, floopCost) => { const pigAbility = pigs[pigKey];...
我在 VS Code 中使用 TypeScript。我使用 JSDoc 来发表评论，因此 IntelliSense 通常将评论显示为工具提示。我使用 Markdown 来格式化这些评论，包括图像。莫斯...
在我们的 eslint 规则中我们有这样的： '多行注释样式': ['错误', '单独行'], 其中不允许这样的评论： /* 一些 评论 */ 赞成这一点： // 一些 // 评论 问题...
你知道 JSDoc 中是否有某种 标签吗？我需要在我的文档中添加如下代码： /** * 该函数执行一些操作，请参见下面的示例： * * var x = f...
我刚刚开始使用 WebStorm 和 JSDoc 来记录我的 JavaScript。我仍然没有找到使用某种 WebStorm 内置功能生成 HTML 文档的方法。我搜索了w...
VSCode 中的 eslintrc 类型安全使用 jsdoc 注释导入打字稿声明
如何让 VSCode 检查 .eslintrc.js 的语法并进行自动补全？我能够对 js 配置文件使用以下结构，该文件遵循我自己的应用程序定义的自定义语法，但是...
我正在 Visual Studio Code 中编写 JavaScript (ES6) 代码，并启用 VSCode 的类型检查，如 VSCode 文档中所述。 当引用另一个文件中定义的类型时（Track in the ex...
我有两个文件src/a.js src/b.js。我希望响应的类型是请求函数的返回值。 如果在 Typescript 中我可以写这个⬇️。jsdoc 中有类似的语法吗？ 我会...
我有课： 类模型{ static get schema() { } // 静态属性 'schema' } 类 CustomModel_1 扩展模型 { } 。 。 。 类 CustomModel_N 扩展模型 { } 我想宣布一个新的
我用 JSDoc 制作了我的 Javascript API 文档。 制作完成后，生成了 ./docs 目录，这是我精心制作的 JSDoc 文档所在的位置。 但我觉得，图标之类的文件太多了，
原型基类的 ctor 中定义的属性不会被标识为派生类中自己的 props
我正在 Eclipse 中使用 JSDoc 记录现有代码，并配置了 jsconfig.json （可以在此处添加它，但它主要显示“es2017”，以及我认为完美工作的路径声明）。 我是
我正在使用 TypeScript 构建一个 Vue 库。我想导出组件的文档，就像导出普通函数一样。 以前我们会这样做： /** * 这是 </desc> <question vote="10"> <p>我正在使用 TypeScript 构建一个 Vue 库。我想导出组件的文档，就像导出普通函数一样。</p> <p>以前我们会这样做：</p> <pre><code><script> /** * This is the documentation of my component. */ export default { } </script> <template></template> </code></pre> <p>但现在有了<pre><code>script setup</code></pre>：</p> <pre><code><script setup lang="ts"> </script> <template></template> </code></pre> <p>我们如何记录组件？</p> </question> <answer tick="true" vote="7"> <p>使用 <pre><code><script setup></code></pre>，您无法在组件导出上使用 JSDoc。</p> <p>它是一个编译器语法糖，可以导出设置函数，因此您显然无法注释编译器“生成”的函数。</p> <p>如果你确实需要 JSDoc，你应该使用常规的 <pre><code><script></code></pre> 和默认导出:)</p> <pre><code><script> /** This is my nice component documentation */ export default { name: 'MyComponent', setup() { // your code }, } </script> </code></pre> <p>也适用于打字稿<pre><code>defineComponent</code></pre>包装器：</p> <pre><code><script> import { defineComponent } from 'vue' /** This is my nice component documentation */ export default defineComponent({ name: 'MyComponent', setup() { // your code } }) </script> </code></pre> <p>编辑：正如 @EstusFlask 在评论中提到的，您可以在 SFC 组件上混合使用 <pre><code><script setup></code></pre> 和 <pre><code><script></code></pre>（请参阅 <a href="https://vuejs.org/api/sfc-script-setup.html#usage-alongside-normal-script" rel="nofollow noreferrer">docs</a>） 所以你可以使用常规脚本来公开你的JSDoc。</p> <pre><code><script setup> // component setup. Takes priority over the eventual `setup()` function of the export object in <script>. </script> <script> /** This is my nice component documentation */ export default { name: 'MyComponent', } </script> </code></pre> </answer> <answer tick="false" vote="0"> <p>我没有评论的声誉<a href="https://stackoverflow.com/a/72003725/18059097">https://stackoverflow.com/a/72003725/18059097</a>或者我会，但似乎你甚至不需要在默认导出中添加任何内容，所以你可以简单地做</p> <pre><code><script> /** * This is my well documented component */ export default {}; </script> <script setup> // your code </script </code></pre> <p>使用这种样式也很有好处，这样您就可以使用编辑器的“转到参考文献”功能，尽管这是一个有点愚蠢的解决方法。</p> </answer> </body></html>
我们如何从 jsDoc 输出中正确排除外部部分？ 我的项目中有很多外部组件，我根本不想在导航面板上显示它们，因为它占用了所有空间，...
JavaScript JSDoc 和 Visual Studio Code：正确记录函数属性
TLDR 版本是：我想使用 JSDoc 在 JavaScript 中记录一个外部“类”，其中属性之一是带有命名参数的函数（方法），并让它显示在 Vis 中...
JsDoc：如何记录对象可以具有任意（未知）属性但具有特定类型？
这与问题30360391类似。我想表达的是，函数的参数是一个普通的JS对象，可以具有任意属性（未知）名称，但所有属性都是对象
在 JSDoc 中，如何记录一个同时采用特定类型的可选命名属性和未知属性的对象
在我的 JavaScript 模块中，我在 JSDoc 中定义了一个在函数中使用的对象类型： //@ts-检查 /** * @typedef {Object} 人 * @property {number} 年龄 * @property {string} 名称 */ /** *
我有一个返回的钩子： /** * * @返回{[ * 验证状态， *（providerName：字符串，redirectSignIn：布尔值）=> Promise， * () => 承诺 *]} */ 嗬...