jsdoc 相关问题

我有以下代码片段文件，我想在其中添加 JSDoc 以便在代码的 {each} 部分中定义表格和表格。从“../store/dialog.s...</desc>导入{对话框}” <question vote="0"> <p>我有以下代码片段文件，我想在其中添加 <strong>JSDoc</strong> 以便定义代码的 <pre><code>tables and table in {each}</code></pre> 部分。</p> <pre><code><script> import { dialog } from "../store/dialog.svelte"; /** * The tables to be displayed. */ let { tables } = $props(); /** * Logs the ID of a table for an order. * * @function * @param {Object} table - The table object containing information about the order. * @param {number} table.id - The unique identifier for the table. * @param {string} table.name - The name of the table. * @returns {void} */ function getOrder(table){ dialog.open = true; dialog.title = `${table.name} Order`; } </script> {#each tables as table} <div class="card bg-base-100 shadow-xl"> <div class="card-body py-2 px-1"> <h2 class="card-title">{table.name} <sup class="text-sm">({table.seats}<i class="fa-solid fa-chair"></i>)</sup> {#if table.order } <sup> <button class="bg-green-500 text-white p-2 rounded-full transition duration-300 ease-in-out transform hover:scale-105 animate-pulse" ></button> </sup> {/if} </h2> <div class="card-actions justify-end"> <button class="btn btn-info btn-xs" onclick="{() => getOrder(table)}">Show Order</button> </div> </div> </div> {/each} </code></pre> <p>这是传递<strong>props</strong>的地方：</p> <pre><code><script> import { tables } from "../store/tables.svelte"; import Table from "../snippets/Table.svelte"; </script> <nav id="mainNav"> <h3>Tables</h3> <div class="divider"></div> <div class="border grid grid-cols-4 gap-4 justify-between py-5 px-2 bg-gray-100"> <Table tables={tables.tables}></Table> </div> </nav> </code></pre> <p>这是<strong>桌子</strong>的商店：</p> <pre><code>import { user } from "./user.svelte" function createTables(){ /** * @typedef {Object} Waiter * @property {number} id */ /** * @typedef {Object} table * @property {number} id * @property {string} name * @property {number|null} seats * @property {null|Object} order * @property {Waiter} waiter */ /** * @type {Array.<table>} tables */ let tables = $state([]) let userTables = $derived(() => { return tables.filter(table => { return +user.currentUser?.id === +table.waiter?.id }) }) let userTablesFree = $derived(() => { return tables.filter(table => { return +user.currentUser?.id === +table.waiter?.id && table.order === null }) }) let userTablesUsed = $derived(() => { return tables.filter(table => { return +user.currentUser?.id === +table.waiter?.id && table.order !== null }) }) let otherTablesFree = $derived(() => { return tables.filter(table => { return +user.currentUser?.id !== +table.waiter?.id && table.order === null }) }) let otherTablesUsed = $derived(() => { return tables.filter(table => { return +user.currentUser?.id !== +table.waiter?.id && table.order !== null }) }) return { get tables(){ return tables }, set tables(newValue){ tables = newValue }, userTables, userTablesFree, userTablesUsed, otherTablesFree, otherTablesUsed } } export const tables = createTables() </code></pre> </question> <answer tick="false" vote="0"> <p>您应该能够使用 <pre><code>@typedef</code></pre> 和 <pre><code>@type</code></pre>，例如 </p> <pre><code>/** * @typedef {Object} Props * @property {number} number A number prop. * @property {string} text A string prop. */ /** @type {Props} */ const { number, text } = $props(); </code></pre> <p>如果您不在单独的 <pre><code>.d.ts</code></pre> 文件中声明类型（我建议对于更复杂的类型），则可以在类型中使用 <pre><code>import</code></pre> 语句。例如</p> <pre><code>/** * @typedef {Object} Props * @property {typeof import('./tables.svelte.js').tables} tables Tables */ </code></pre> <p>另外：我<strong>不</strong>建议使用全局状态（<pre><code>export const tables = ...</code></pre>），特别是如果你有SSR，那么这是一个隐私/安全风险。</p> </answer> </body></html>

svelte jsdoc svelte-5

回答 0 投票 0

为以另一个函数作为参数的函数制作 JSDoc 注释

想象一个接受“onUpdate”函数作为参数的函数： /** * @param {函数} onUpdate * @返回{null} */ 静态异步初始化（onUpdate）{ ... onUpdate(true);...

javascript jsdoc

回答 2 投票 0

如何记录泛型类型参数？

假设下面是一个泛型类型，我应该用什么来代替 ???正确记录T？ /** * ??? T 的描述。 */ 类我的类 { } 在 C# 中我会使用。有没有

typescript jsdoc

回答 3 投票 0

如何为 TypeScript 泛型编写 JSDocs？

我正在尝试使用 JSDocs 来获取 isEqual(object1: T, object2: T) 但我收到警告：类型“T”未定义 .eslintjsdoc/no-undefined-types。我该如何修复这里的 eslint 警告？ /*...