JSDoc是一种用于向JavaScript源代码添加内联API文档的语法。这与解析和操作遵循JSDoc语法的代码的各种工具不同。
我无法让 jsdoc 3.5.5 生成内联注释的文档。 请参阅所附示例： /** * 我的测试用例类 */ 类测试用例{ donstWorkA(/** 字符串 */ str) /** 数字 */ { ...
JSDoc、DocDash、@typedef 未出现在目录中
我正在尝试让我的目录列出每个模块的常量、函数和 typedef，从而允许搜索文档。 我将 DocDash 与 JSDoc 一起使用。 JSDoc 似乎是
我正在开发一个 JavaScript NPM 库包，并尝试让 typescript 从嵌入文件中的 jsdocs 生成 .d.ts 文件。 假设我有以下三个文件： index.js，那个...
我正在尝试评论描述整体功能的整个文件。我把这样的东西放在每个文件的顶部 /** * @file 具有辅助函数的文件，有助于读取配置 J...
我用以下代码提炼出了问题的本质： 完整源码 我有基类、派生类、派生类2： 基类{ 静态获取类型() { 返回“基数”； } } 德班...
如何注释解构声明的变量，以便鼠标悬停在它们上方时显示描述[重复]
我尝试添加描述但没有用，无论我如何注释它都只会显示类型。 以下方法均无效。 // 不工作 /** 不工作 */ const [状态，setSt...
如果属性名称是字符串，如“aria-label”，如何编写 JSDoc
我想为一些React组件编写JSDoc： /** * 一些组件 * @param {Object} props - 组件的 props * @param {boolean} [props.active=false] - 活跃 * @param {string} props.te...
如果我有一个将对象作为参数的 JavaScript 函数，我可以使用 JSDoc 描述该对象的预期属性，如下所示： /** * @参数栏 * @param bar.baz {number} * @param bar.q...
我想让这个函数接收一个参数并返回它的类（如果是对象）、参数本身（如果是函数）或遗留对象构造函数（如果有其他）。 在 JavaScript 中的示例...
如何在package-scripts.js中注释以显示在package.json中？
目标 我想在 package.json 中显示 package-scripts.js 中 nps 命令的注释，如下所示： 尝试过 我实际上不知道这个覆盖层的内容在哪里（“通过‘npm test’运行
我这次来是带着一个非常简单的问题。在 JSDOC 上，有没有一种方法可以描述这在类中代表什么？ /** * 这是所发生事情的一个非常简化的版本 * * 我想要...
如何仅使用 JavaScript / JSDocs 实现具有动态键的对象的类型提示？ （TypeScript 知道索引签名，但这不适用于 TypeScript。） 我想使用 JSDoc 来记录参数...
如何在 Visual Studio 中预览折叠的 JSDoc 注释？
我使用的是 Visual Studio 2022 v17.9.5，并且我有带有 JSDoc 注释的 JavaScript 文件，展开后如下所示： 当我折叠 JSDoc 注释时，它们就变成了一个带有三个点的框......
我有这个用 Typescript Jsdocs 输入的函数： /** * 我的功能描述... * @see {@link ../docs/csrf-issues.md} * @param httpClientRef : AxiosInstance * @return {承诺<...
我正在使用 Visual Studio Code 的 Javascript 类型检查功能。 对于那些不熟悉的人来说，这可以实现推断类型，因此您可以享受在 VS Code 中键入的许多好处，而无需编写类型。
如何将 jsdoc 类型添加到解构变量中？ （VSCode）
所以我有一个带有数据属性的响应对象。 对于本示例，其数据是文本类型。 我想要数据属性，并且我希望 VSCode 能够识别它的类型，以便我可以获得其中的一些
是否可以告诉 jsdoc 在与源代码分开的文件中查找该代码的文档？
我希望内联注释尽可能短，因为我的经验是超过 3 或 4 行的注释往往会被掩盖，从而产生很多不必要的“阅读手册...
使用 @component 生成 React 18 项目的 JSDoc 文档
我正在尝试为 React 18 项目设置带有更好文档的 JSDoc，以便我可以使用 @component 装饰器来记录我的组件。 当我尝试安装 better-docs 时，出现以下错误： npm ...
以下是界面。 /** * @界面 */ 类 ISomething { /** * @return {数字} */ 静态 aMethod() { 抛出新的错误（'未实现'）； } /** * @type {Object}...
我有一个函数，它接受两个参数，例如： 函数示例（类型，val）{ // 根据“type”处理“val” } val 可接受的类型取决于类型。 ...