如何在@typedef 中標記棄用的屬性？

[英]How to mark a property deprecated in a @typedef?

我想將一個屬性（例如下面的qux ）標記為已棄用： 我應該提一下，我想在 JSDoc 評論中這樣做，而不是使用 TypeScript。 ...

如何在 typescript TSDoc 中描述 function 的 object 屬性參數？

[英]How to describe object properties parameters for a function in typescript TSDoc?

如何在 TSDoc 中添加a和b的描述？ 我希望當我 hover 在 function 調用中的屬性參數上顯示描述fn({ a }) 。 ...

如何在 object 屬性中轉發 TSDoc 描述

[英]How to forward a TSDoc description within an object property

例如，我有一個 function： 還有一個像這樣的 object： 所以我想在 VScode 的internals.myFunction中看到這個描述：“函數返回 null”。 但是對於像@inheritDoc、@link 之類的符號，我只是按原樣看待它們： {@inheritDoc myFunc ...

如何為具有擴展接口的泛型類型的函數參數做 TypeScript tsdoc 文檔？

[英]How to do TypeScript tsdoc documentation for function argument with generic type that extends an interface?

考慮以下代碼，注意someField的文檔： interface Test { /** * Some description. * lorum ipsum. * foo bar. */ someField: string; } functio ...

防止為 typescript 項目中的標准反應方法詢問“缺少 JSDoc 評論”

[英]prevent asking "Missing JSDoc comment" for standard react methods in typescript project

我們有 Typescript 的 React 項目。我們使用TSDoc來標准化 TypeScript 代碼中使用的文檔注釋我們的 eslint.trc 文件如下： 如何配置此配置文件，因為不詢問 ESLINT 關於記錄標准反應方法，如constructor(),static getDerivedS ...

Monaco Editor (TypeScript)：用更多按鈕/鏈接/動作裝飾 JSDoc 或 TSDoc

[英]Monaco Editor (TypeScript): Decorate JSDoc or TSDoc with further buttons/links/actions

我正在為 TypeScript 語言使用 Microsoft Monaco Editor。 TypeScript 類和函數有 JSDoc。 我想添加按鈕/鏈接/等。 到現有的 JSDoc，以便在用戶在代碼完成中單擊它們時調用 JavaScript function。 看來我不能簡單地將 HTML ...

如何從 tsdoc / typedoc 中正確排除測試文件

[英]How to properly exclude test files from tsdoc / typedoc

我正在測試一些不同的文檔引擎，我想為我們的大型項目嘗試 typedoc。 我們在整個項目中有各種測試文件（ somefile.test.ts或someotherfile.test.tsx ）。 我正在努力讓 typedoc 忽略這些文件。 我做了npm i -D typedoc ，然后在我的 tsc ...

在 TSDoc 中鍵入 React 道具的正確格式是什么？

[英]What is the proper format for typing React props in TSDoc?

我正在嘗試將 TSDoc 標准用於評論用 Typescript 編寫的 React 項目（着眼於使用 Typedoc 生成文檔），但找不到任何明確的答案來注釋 React props object 的首選方法。 到目前為止，我已經有了這個，其中MyProps是一個接口：/** * Descrip ...

忽略來自特定 eslint 插件的特定文件

[英]Ignore specific file from specific eslint plugin

我正在使用運行良好eslint-plugin-tsdoc ，除了我不需要 linting 的文件，例如，任何使用 apidoc 而不是 tsdoc 注釋 styles 的 api 路由。 這會在運行任何 linting 時導致錯誤。 無論如何我可以忽略eslint-plugin-tsdoc文件嗎？ ...

TSDoc eslint-plugin-tsdoc 忽略特定文件

[英]TSDoc eslint-plugin-tsdoc ignore specific files

我剛剛開始將 TSDoc 與 TypeDoc 結合使用，我喜歡它。 我有一個小問題，嗯，真的很煩。 我希望eslint-plugin-tsdoc忽略將用於生成 api 文檔的文件，我將使用apidocjs.com為我生成該文檔。 在PhpStorm和command line中，我收到這些文件的警告， ...

如何為打字稿枚舉類型 {[key]: value } 生成文檔？

[英]how to generate doc for typescript enum type {[key]: value }?

我正在 Typescript 中為 nodeJS 編寫記錄器服務。 我有一個枚舉如下： 然后我有一個 setLogType 函數： 我的問題是我不知道如何為type參數制作文檔。 我的期望是推薦會像這樣顯示 ...

tsdoc-param-tag-with-invalid-name：@param 塊后面應該跟一個有效的參數名稱（TypeScript ESLint 和 React）

[英]tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name (TypeScript ESLint and React)

我將 JSDoc 和 TSDoc 用於帶有 TypeScript 的 React Native 項目。 記錄道具時有一些奇怪的行為。 所有@param: props.propName 都帶有下划線消息： 另外，我不得不添加 : Props 兩次，因為如果我只將它放在 FC 中，則道具會帶有下划 ...

缺少 JSDoc @param "props.children" 類型。 和缺少 JSDoc @param "props.children" 類型。 使用 React Native FunctionalComponents

[英]Missing JSDoc @param "props.children" type. and Missing JSDoc @param "props.children" type. with React Native FunctionalComponents

我在本機反應項目上使用 JSDoc 和 TSDoc。 這是文件： 我有兩個警告： 在第二個@param： 在 JSDoc 行的開頭： 我真的不知道如何記錄我猜的道具。 有什么見解嗎？ 謝謝編輯： 如果我將類型添加為 @param {Type}，TSDoc 會抱怨，因為它是 TypeScript： ...

用 JsDoc 轉換 Typescript

[英]Convert Typescript with JsDoc

我可以使用 JSDoc 將 TypeScript 文件轉換為 JavaScript 文件嗎？ 例如，如果我有這個main.ts文件： 它將被轉換為類似main.js文件的內容： 等等。 有沒有辦法做到這一點？ 謝謝！ ...

為 Typescript 聯合類型編寫更具描述性的智能感知文檔

[英]Writing more descriptive intellisense docs for Typescript Union Types

給定以下代碼，當我們調用baz function 時，預先輸入將顯示 'a' 和 'b' 作為可能的值。 但是，如果我想為每個值提供額外的文檔，我該怎么做呢？ 例如，如果需要這樣的行為： 我想我應該提供更多有關我正在嘗試做的事情以及原因的背景信息： 考慮以下示例： 其中 House 是一個 Re ...

如何將嵌套參數添加到 tsdoc 文檔

[英]How do you add nested params to tsdoc documentation

下面的代碼顯示了可能用於注冊用戶的功能。 請求正文接受多個嵌套參數，例如firstName 、 lastName等。 如何使用 tsdoc 充分記錄這些嵌套參數？ ...