我想将一个属性（例如下面的qux ）标记为已弃用： 我应该提一下，我想在 JSDoc 评论中这样做，而不是使用 TypeScript。 ...
如何在 TSDoc 中添加a和b的描述？ 我希望当我 hover 在 function 调用中的属性参数上显示描述fn({ a }) 。 ...
例如，我有一个 function： 还有一个像这样的 object： 所以我想在 VScode 的internals.myFunction中看到这个描述：“函数返回 null”。 但是对于像@inheritDoc、@link 之类的符号，我只是按原样看待它们： {@inheritDoc myFunc ...
考虑以下代码，注意someField的文档： interface Test { /** * Some description. * lorum ipsum. * foo bar. */ someField: string; } functio ...
我们有 Typescript 的 React 项目。我们使用TSDoc来标准化 TypeScript 代码中使用的文档注释我们的 eslint.trc 文件如下： 如何配置此配置文件，因为不询问 ESLINT 关于记录标准反应方法，如constructor(),static getDerivedS ...
我正在为 TypeScript 语言使用 Microsoft Monaco Editor。 TypeScript 类和函数有 JSDoc。 我想添加按钮/链接/等。 到现有的 JSDoc，以便在用户在代码完成中单击它们时调用 JavaScript function。 看来我不能简单地将 HTML ...
我正在测试一些不同的文档引擎，我想为我们的大型项目尝试 typedoc。 我们在整个项目中有各种测试文件（ somefile.test.ts或someotherfile.test.tsx ）。 我正在努力让 typedoc 忽略这些文件。 我做了npm i -D typedoc ，然后在我的 tsc ...
我正在尝试将 TSDoc 标准用于评论用 Typescript 编写的 React 项目（着眼于使用 Typedoc 生成文档），但找不到任何明确的答案来注释 React props object 的首选方法。 到目前为止，我已经有了这个，其中MyProps是一个接口：/** * Descrip ...
我正在使用运行良好eslint-plugin-tsdoc ，除了我不需要 linting 的文件，例如，任何使用 apidoc 而不是 tsdoc 注释 styles 的 api 路由。 这会在运行任何 linting 时导致错误。 无论如何我可以忽略eslint-plugin-tsdoc文件吗？ ...
我刚刚开始将 TSDoc 与 TypeDoc 结合使用，我喜欢它。 我有一个小问题，嗯，真的很烦。 我希望eslint-plugin-tsdoc忽略将用于生成 api 文档的文件，我将使用apidocjs.com为我生成该文档。 在PhpStorm和command line中，我收到这些文件的警告， ...
我正在 Typescript 中为 nodeJS 编写记录器服务。 我有一个枚举如下： 然后我有一个 setLogType 函数： 我的问题是我不知道如何为type参数制作文档。 我的期望是推荐会像这样显示 ...
我将 JSDoc 和 TSDoc 用于带有 TypeScript 的 React Native 项目。 记录道具时有一些奇怪的行为。 所有@param: props.propName 都带有下划线消息： 另外，我不得不添加 : Props 两次，因为如果我只将它放在 FC 中，则道具会带有下划 ...
我在本机反应项目上使用 JSDoc 和 TSDoc。 这是文件： 我有两个警告： 在第二个@param： 在 JSDoc 行的开头： 我真的不知道如何记录我猜的道具。 有什么见解吗？ 谢谢编辑： 如果我将类型添加为 @param {Type}，TSDoc 会抱怨，因为它是 TypeScript： ...
我可以使用 JSDoc 将 TypeScript 文件转换为 JavaScript 文件吗？ 例如，如果我有这个main.ts文件： 它将被转换为类似main.js文件的内容： 等等。 有没有办法做到这一点？ 谢谢！ ...
给定以下代码，当我们调用baz function 时，预先输入将显示 'a' 和 'b' 作为可能的值。 但是，如果我想为每个值提供额外的文档，我该怎么做呢？ 例如，如果需要这样的行为： 我想我应该提供更多有关我正在尝试做的事情以及原因的背景信息： 考虑以下示例： 其中 House 是一个 Re ...
下面的代码显示了可能用于注册用户的功能。 请求正文接受多个嵌套参数，例如firstName 、 lastName等。 如何使用 tsdoc 充分记录这些嵌套参数？ ...